Interface ChannelMessage.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ChannelMessage.Builder,
,ChannelMessage> SdkBuilder<ChannelMessage.Builder,
,ChannelMessage> SdkPojo
- Enclosing class:
ChannelMessage
-
Method Summary
Modifier and TypeMethodDescriptionchannelArn
(String channelArn) The ARN of the channel.The content of the channel message.contentType
(String contentType) The content type of the channel message.createdTimestamp
(Instant createdTimestamp) The time at which the message was created.lastEditedTimestamp
(Instant lastEditedTimestamp) The time at which a message was edited.lastUpdatedTimestamp
(Instant lastUpdatedTimestamp) The time at which a message was updated.messageAttributes
(Map<String, MessageAttributeValue> messageAttributes) The attributes for the channel message.The ID of a message.The message metadata.persistence
(String persistence) The persistence setting for a channel message.persistence
(ChannelMessagePersistenceType persistence) The persistence setting for a channel message.Hides the content of a message.default ChannelMessage.Builder
sender
(Consumer<Identity.Builder> sender) The message sender.The message sender.default ChannelMessage.Builder
The status of the channel message.status
(ChannelMessageStatusStructure status) The status of the channel message.subChannelId
(String subChannelId) The ID of the SubChannel.target
(Collection<Target> target) The target of a message, a sender, a user, or a bot.target
(Consumer<Target.Builder>... target) The target of a message, a sender, a user, or a bot.The target of a message, a sender, a user, or a bot.The message type.type
(ChannelMessageType type) The message type.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
-
channelArn
The ARN of the channel.
- Parameters:
channelArn
- The ARN of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageId
The ID of a message.
- Parameters:
messageId
- The ID of a message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
content
The content of the channel message. 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 content of the channel message. 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
The message metadata.
- Parameters:
metadata
- The message metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The message type.
- Parameters:
type
- The message type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The message type.
- Parameters:
type
- The message type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdTimestamp
The time at which the message was created.
- Parameters:
createdTimestamp
- The time at which the message was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastEditedTimestamp
The time at which a message was edited.
- Parameters:
lastEditedTimestamp
- The time at which a message was edited.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTimestamp
The time at which a message was updated.
- Parameters:
lastUpdatedTimestamp
- The time at which a message was updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sender
The message sender.
- Parameters:
sender
- The message sender.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sender
The message sender.
This is a convenience method that creates an instance of theIdentity.Builder
avoiding the need to create one manually viaIdentity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosender(Identity)
.- Parameters:
sender
- a consumer that will call methods onIdentity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
redacted
Hides the content of a message.
- Parameters:
redacted
- Hides the content of a message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
persistence
The persistence setting for a channel message.
- Parameters:
persistence
- The persistence setting for a channel message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
persistence
The persistence setting for a channel message.
- Parameters:
persistence
- The persistence setting for a channel message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the channel message.
- Parameters:
status
- The status of the channel message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the channel message.
This is a convenience method that creates an instance of theChannelMessageStatusStructure.Builder
avoiding the need to create one manually viaChannelMessageStatusStructure.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatus(ChannelMessageStatusStructure)
.- Parameters:
status
- a consumer that will call methods onChannelMessageStatusStructure.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The content type of the channel message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgs
for success responses andapplication/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 channel message. For Amazon Lex V2 bot responses, the content type isapplication/amz-chime-lex-msgs
for success responses andapplication/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.
-
target
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
- Parameters:
target
- The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
target
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
- Parameters:
target
- The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
target
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
This is a convenience method that creates an instance of theTarget.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totarget(List<Target>)
.- Parameters:
target
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-