Interface WebSocketChatApi
- All Known Implementing Classes:
WebSocketChatController
public interface WebSocketChatApi
API contract for WebSocketChatController. Annotated for documentation purposes
to describe STOMP destinations and behaviors even though these are not REST endpoints.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddUser(UUID conversationId, InputChatMessageDto chatMessage, WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) voidbroadcastSystemMessage(UUID conversationId, String content) voidremoveUser(UUID conversationId, InputChatMessageDto chatMessage, WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) voidsendDirectMessage(UUID conversationId, InputChatMessageDto chatMessage, WebSocketAuthentication principal) voidsendInvitationNotification(UUID conversationId, UUID invitedUserId, WebSocketAuthentication principal) voidsendMessage(UUID conversationId, InputChatMessageDto chatMessage, WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) voidsendTypingIndicator(UUID conversationId, InputTypingMessageDto inputTypingMessageDto, WebSocketAuthentication principal) voidsendUserNotification(UUID userId, String content, MessageType messageType)
-
Method Details
-
sendMessage
void sendMessage(@DestinationVariable UUID conversationId, @Payload InputChatMessageDto chatMessage, @AuthenticationPrincipal WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) -
addUser
void addUser(@DestinationVariable UUID conversationId, @Payload InputChatMessageDto chatMessage, @AuthenticationPrincipal WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) -
removeUser
void removeUser(@DestinationVariable UUID conversationId, @Payload InputChatMessageDto chatMessage, @AuthenticationPrincipal WebSocketAuthentication principal, org.springframework.messaging.simp.SimpMessageHeaderAccessor headerAccessor) -
sendTypingIndicator
void sendTypingIndicator(@DestinationVariable UUID conversationId, @Payload InputTypingMessageDto inputTypingMessageDto, @AuthenticationPrincipal WebSocketAuthentication principal) -
sendDirectMessage
void sendDirectMessage(@DestinationVariable UUID conversationId, @Payload InputChatMessageDto chatMessage, @AuthenticationPrincipal WebSocketAuthentication principal) -
broadcastSystemMessage
-
sendUserNotification
-
sendInvitationNotification
void sendInvitationNotification(UUID conversationId, UUID invitedUserId, @AuthenticationPrincipal WebSocketAuthentication principal)
-