Package com.flowable.engage.message.api

Interface ConversationStatus

All Known Subinterfaces:
ConversationStatusEntity
All Known Implementing Classes:
ConversationStatusEntityImpl
public interface ConversationStatus
This represents the information for the last read message for a certain user in a certain conversation
Author:
Filip Hrisafov author Joram Barrez

  • Method Details

    • getTenantId

      String getTenantId()
      Returns:
      Tenant for this conversation

    • getUserId

      String getUserId()
      Returns:
      The id of the user for which this entry is created.

    • getConversationId

      String getConversationId()
      Returns:
      The id of the conversation for which this entry is created.

    • getFilterId

      String getFilterId()
      Returns:
      The id of the filter for which this entry is created.

    • getUnreadMessageCount

      int getUnreadMessageCount()
      Returns:
      The total number of unread messages for this conversation and user

    • getUnreadPersonalMessageCount

      int getUnreadPersonalMessageCount()
      Returns:
      The total number of unread personal messages for this conversation and user. This will be the same as the unread message count, if this is a DM, GM, self, etc type of conversation. For Channels, desks, etc it only counts mentions or things like @channel, etc

    • getUnsentMessageCount

      int getUnsentMessageCount()
      Returns:
      The total number of unsent messages for this conversation and user (a message is considered unsent, if it was not sent over WS or as a push notification)

    • getLastReadMessageId

      String getLastReadMessageId()
      Returns:
      The id of the last read message within that conversation

    • getLastReadMessageTimestamp

      Date getLastReadMessageTimestamp()
      Returns:
      The timestamp of the last read message within this conversation

    • getLastSentMessageId

      String getLastSentMessageId()
      The id of the last sent message to within the conversation to the user (sent means either pushed as a mobile push message or over WS or fetched from a read of the conversation).

    • getLastSentMessageTimestamp

      Date getLastSentMessageTimestamp()
      Returns:
      The timestamp of the last sent message within this conversation.