Interface Conversation
public interface Conversation
A collection of messages exchanged between a contact and an app. Conversations are normally
created on the fly by Conversation API once a message is sent and there is no active conversation
already. There can be only one active conversation at any given time between a particular contact
and an app.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Conversation.Builderbuilder()Getting builderFlag for whether this conversation is active.Get activeChannelgetAppId()The ID of the participating app.The ID of the participating contact.Arbitrary correlation ID related to the MT message set by the Conversation API user.getId()The ID of the conversation.The timestamp of the latest message in the conversation.Arbitrary data set by the Conversation API clients and/or provided in theconversation_metadatafield of a SendMessageRequest.
-
Method Details
-
getActive
Boolean getActive()Flag for whether this conversation is active.- Returns:
- active
-
getActiveChannel
ConversationChannel getActiveChannel()Get activeChannel- Returns:
- activeChannel
-
getAppId
String getAppId()The ID of the participating app.- Returns:
- appId
-
getContactId
String getContactId()The ID of the participating contact.- Returns:
- contactId
-
getMetadataJson
Object getMetadataJson()Arbitrary data set by the Conversation API clients and/or provided in theconversation_metadatafield of a SendMessageRequest. A valid JSON object.- Returns:
- metadataJson
-
getCorrelationId
String getCorrelationId()Arbitrary correlation ID related to the MT message set by the Conversation API user.- Returns:
- correlationId
-
getId
String getId()The ID of the conversation.- Returns:
- id
-
getLastReceived
Instant getLastReceived()The timestamp of the latest message in the conversation. The timestamp will be Thursday January 01, 1970 00:00:00 UTC if the conversation contains no messages.- Returns:
- lastReceived
- Read Only
- This field is returned by the server and cannot be modified
-
builder
Getting builder- Returns:
- New Builder instance
-