Package com.flowable.engage.rest.service.api.conversation

Class ConversationResource

java.lang.Object

com.flowable.engage.rest.service.api.conversation.AbstractEngageResource

com.flowable.engage.rest.service.api.conversation.ConversationResource

@RestController
public class ConversationResource
extends AbstractEngageResource

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected ConversationResourceService	conversationResourceService

Fields inherited from class com.flowable.engage.rest.service.api.conversation.AbstractEngageResource

conversationService, securityHelper

Constructor Summary

Constructors

Constructor	Description
ConversationResource(ConversationResourceService conversationResourceService, com.flowable.license.LicenseCheckService licenseCheckService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<java.lang.Void>	archiveConversation(java.lang.String conversationId, java.security.Principal principal)
org.springframework.http.ResponseEntity<ConversationResponse>	findConversation(java.lang.String conversationId, java.security.Principal principal)
org.springframework.http.ResponseEntity<ConversationLastReadStatusResponse>	getConversationLastReadStatus(java.lang.String conversationId)
org.springframework.http.ResponseEntity<java.lang.Void>	reopenConversation(java.lang.String conversationId, java.security.Principal principal)
org.springframework.http.ResponseEntity<ConversationResponse>	startConversation(StartConversationRequest request, java.security.Principal principal)
org.springframework.http.ResponseEntity<ConversationResponse>	updateConversation(java.lang.String conversationId, UpdateConversationRequest request, java.security.Principal principal)
org.springframework.http.ResponseEntity<ConversationResponse>	updateConversationAvatar(java.lang.String conversationId, java.security.Principal principal, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<java.lang.Void>	userTyping(java.lang.String conversationId, java.security.Principal principal)

Methods inherited from class com.flowable.engage.rest.service.api.conversation.AbstractEngageResource

addPermissions, currentUserHasAccess, currentUserHasAdminRights, currentUserIsSuperAdmin, validateAccessAndGetConversation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

conversationResourceService

protected final ConversationResourceService conversationResourceService

Constructor Details

ConversationResource

public ConversationResource(ConversationResourceService conversationResourceService, com.flowable.license.LicenseCheckService licenseCheckService)

Method Details

startConversation

@PostMapping("/conversations") public org.springframework.http.ResponseEntity<ConversationResponse> startConversation(@RequestBody StartConversationRequest request, java.security.Principal principal)

findConversation

@GetMapping("/conversations/{conversationId}") public org.springframework.http.ResponseEntity<ConversationResponse> findConversation(@PathVariable java.lang.String conversationId, java.security.Principal principal)

updateConversation

@PutMapping("/conversations/{conversationId}") public org.springframework.http.ResponseEntity<ConversationResponse> updateConversation(@PathVariable java.lang.String conversationId, @RequestBody UpdateConversationRequest request, java.security.Principal principal)

getConversationLastReadStatus

@GetMapping("/conversations/{conversationId}/last-read-status") public org.springframework.http.ResponseEntity<ConversationLastReadStatusResponse> getConversationLastReadStatus(@PathVariable java.lang.String conversationId)

archiveConversation

@PostMapping("/conversations/{conversationId}/archive") public org.springframework.http.ResponseEntity<java.lang.Void> archiveConversation(@PathVariable java.lang.String conversationId, java.security.Principal principal)

reopenConversation

@PostMapping("/conversations/{conversationId}/reopen") public org.springframework.http.ResponseEntity<java.lang.Void> reopenConversation(@PathVariable java.lang.String conversationId, java.security.Principal principal)

userTyping

@PostMapping("/conversations/{conversationId}/user-typing") public org.springframework.http.ResponseEntity<java.lang.Void> userTyping(@PathVariable java.lang.String conversationId, java.security.Principal principal)

updateConversationAvatar

@PostMapping(value="/conversations/{conversationId}/avatar/data", consumes="multipart/form-data") public org.springframework.http.ResponseEntity<ConversationResponse> updateConversationAvatar(@PathVariable java.lang.String conversationId, java.security.Principal principal, javax.servlet.http.HttpServletRequest request)