Interface AppMessage<T extends AppMessageBody>
- Type Parameters:
T- Body type for message
- All Superinterfaces:
ConversationMessageBody
Message originating from an app
- Since:
- 1.3
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceAppMessage.Builder<T extends AppMessageBody>Dedicated Builder -
Method Summary
Modifier and TypeMethodDescriptionstatic <T extends AppMessageBody>
AppMessage.Builder<T> builder()Getting BuildergetAgent()Get agentgetBody()Get message bodyChannel specific messages, overriding any transcoding.Allows you to specify a channel and define a corresponding channel specific message payload that will override the standard Conversation API message types.Override the message's content for specified channels.
-
Method Details
-
getBody
T getBody()Get message body- Returns:
- Message body
-
getExplicitChannelMessage
Map<ConversationChannel,String> getExplicitChannelMessage()Allows you to specify a channel and define a corresponding channel specific message payload that will override the standard Conversation API message types. The key in the map must point to a valid conversation channel as defined in the enumConversationChannel. The message content must be provided in string format. You may use the transcoding endpoint to help create your message. For more information about how to construct an explicit channel message for a particular channel, see that channel's corresponding documentation (for example, using explicit channel messages with the WhatsApp channel).- Returns:
- explicitChannelMessage
-
getExplicitChannelOmniMessage
Map<OmniMessageOverride.ChannelSpecificTemplate,OmniMessageOverride> getExplicitChannelOmniMessage()Override the message's content for specified channels. The key in the map must point to a valid conversation channel as defined in the enumConversationChannel. The content defined under the specified channel will be sent on that channel.- Returns:
- explicitChannelOmniMessage
-
getChannelSpecificMessage
Map<ConversationChannel,ChannelSpecificMessage> getChannelSpecificMessage()Channel specific messages, overriding any transcoding. The structure of this property is more well-defined than the open structure of the `explicit_channel_message` property, and may be easier to use. The key in the map must point to a valid conversation channel as defined in the enum `ConversationChannel`.- Returns:
- channelSpecificMessage
-
getAgent
Agent getAgent()Get agent- Returns:
- agent
-
builder
Getting Builder- Returns:
- New Builder instance
- Since:
- 1.0
-