Interface ChatProvider


  • public interface ChatProvider
    Provides chat connections.
    • Method Summary

      Modifier and Type Method Description
      default Chat getChatById​(java.lang.String id)
      Gets a conversation by a specific Id for this platform.
      java.util.List<Chat> getChats()
      Gets the conversations this platform provides.
      default Chat getPrivateChat​(User user)
      Gets a private message conversation for a specific user.
    • Method Detail

      • getChats

        java.util.List<Chat> getChats()
        Gets the conversations this platform provides.
        Returns:
        immutable list of presently provided Conversations.
      • getChatById

        default Chat getChatById​(java.lang.String id)
        Gets a conversation by a specific Id for this platform.
        Parameters:
        id - Chat Id,
        Returns:
        Chat instance if one exists, null otherwise.
      • getPrivateChat

        default Chat getPrivateChat​(User user)
        Gets a private message conversation for a specific user.
        Parameters:
        user - User to get a PM conversation for.
        Returns:
        Private message conversation for the specified user, null if one cannot be found.