Interface ChannelMessageCallback.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>, SdkBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>, SdkPojo

Enclosing class:

ChannelMessageCallback

public static interface ChannelMessageCallback.Builder
extends SdkPojo, CopyableBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>

Method Summary

Modifier and Type	Method	Description
ChannelMessageCallback.Builder	content(String content)	The message content.
ChannelMessageCallback.Builder	contentType(String contentType)	The content type of the call-back message.
ChannelMessageCallback.Builder	messageAttributes(Map<String,MessageAttributeValue> messageAttributes)	The attributes for the channel message.
ChannelMessageCallback.Builder	messageId(String messageId)	The message ID.
ChannelMessageCallback.Builder	metadata(String metadata)	The message metadata.
default ChannelMessageCallback.Builder	pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification)	The push notification configuration of the message.
ChannelMessageCallback.Builder	pushNotification(PushNotificationConfiguration pushNotification)	The push notification configuration of the message.
ChannelMessageCallback.Builder	subChannelId(String subChannelId)	The ID of the SubChannel.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

messageId

ChannelMessageCallback.Builder messageId(String messageId)

The message ID.

Parameters:

messageId - The message ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

content

ChannelMessageCallback.Builder content(String content)

The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Parameters:

content - The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

ChannelMessageCallback.Builder metadata(String metadata)

The message metadata.

Parameters:

metadata - The message metadata.

Returns:

Returns a reference to this object so that method calls can be chained together.

pushNotification

ChannelMessageCallback.Builder pushNotification(PushNotificationConfiguration pushNotification)

The push notification configuration of the message.

Parameters:

pushNotification - The push notification configuration of the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

pushNotification

default ChannelMessageCallback.Builder pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification)

The push notification configuration of the message.

This is a convenience method that creates an instance of the PushNotificationConfiguration.Builder avoiding the need to create one manually via PushNotificationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pushNotification(PushNotificationConfiguration).

Parameters:

pushNotification - a consumer that will call methods on PushNotificationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• pushNotification(PushNotificationConfiguration)

messageAttributes

ChannelMessageCallback.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Parameters:

messageAttributes - The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

subChannelId

ChannelMessageCallback.Builder subChannelId(String subChannelId)

The ID of the SubChannel.

Parameters:

subChannelId - The ID of the SubChannel.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentType

ChannelMessageCallback.Builder contentType(String contentType)

The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Parameters:

contentType - The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.