Interface WebSocketService
- All Known Implementing Classes:
DefaultWebSocketService
public interface WebSocketService
Service contract for interacting with websockets.
Each method is documented to improve generated JavaDoc and maintainability.
-
Method Summary
Modifier and TypeMethodDescriptionaddUser(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle user joining a conversationbroadcastSystemMessage(UUID conversationId, String content) Broadcast system message to all users in a conversationremoveUser(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle user leaving a conversationsendDirectMessage(UUID userId, UUID receiverId, InputChatMessageDto inputChatMessageDto) Handle chat messages sent to a specific conversationsendInvitation(UUID userId, UUID conversationId, UUID receiverId) Send invitation notification for group chatssendMessage(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle chat messages sent to a specific conversationsendTypingIndicator(UUID userId, UUID conversationId, InputTypingMessageDto inputTypingMessageDto) Handle typing indicatorssendUserNotification(UUID userId, String content, MessageType messageType) Send notification to a specific user
-
Method Details
-
sendMessage
OutputChatMessageDto sendMessage(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle chat messages sent to a specific conversation -
sendDirectMessage
OutputChatMessageDto sendDirectMessage(UUID userId, UUID receiverId, InputChatMessageDto inputChatMessageDto) Handle chat messages sent to a specific conversation -
sendTypingIndicator
OutputChatMessageDto sendTypingIndicator(UUID userId, UUID conversationId, InputTypingMessageDto inputTypingMessageDto) Handle typing indicators -
addUser
OutputChatMessageDto addUser(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle user joining a conversation -
removeUser
OutputChatMessageDto removeUser(UUID userId, UUID conversationId, InputChatMessageDto inputChatMessageDto) Handle user leaving a conversation -
broadcastSystemMessage
Broadcast system message to all users in a conversation -
sendUserNotification
Send notification to a specific user -
sendInvitation
Send invitation notification for group chats
-