Interface ChannelMessage.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ChannelMessage.Builder,ChannelMessage>,SdkBuilder<ChannelMessage.Builder,ChannelMessage>,SdkPojo
- Enclosing class:
- ChannelMessage
public static interface ChannelMessage.Builder extends SdkPojo, CopyableBuilder<ChannelMessage.Builder,ChannelMessage>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ChannelMessage.BuilderchannelArn(String channelArn)The ARN of the channel.ChannelMessage.Buildercontent(String content)The content of the channel message.ChannelMessage.BuildercontentType(String contentType)The content type of the channel message.ChannelMessage.BuildercreatedTimestamp(Instant createdTimestamp)The time at which the message was created.ChannelMessage.BuilderlastEditedTimestamp(Instant lastEditedTimestamp)The time at which a message was edited.ChannelMessage.BuilderlastUpdatedTimestamp(Instant lastUpdatedTimestamp)The time at which a message was updated.ChannelMessage.BuildermessageAttributes(Map<String,MessageAttributeValue> messageAttributes)The attributes for the channel message.ChannelMessage.BuildermessageId(String messageId)The ID of a message.ChannelMessage.Buildermetadata(String metadata)The message metadata.ChannelMessage.Builderpersistence(String persistence)The persistence setting for a channel message.ChannelMessage.Builderpersistence(ChannelMessagePersistenceType persistence)The persistence setting for a channel message.ChannelMessage.Builderredacted(Boolean redacted)Hides the content of a message.default ChannelMessage.Buildersender(Consumer<Identity.Builder> sender)The message sender.ChannelMessage.Buildersender(Identity sender)The message sender.default ChannelMessage.Builderstatus(Consumer<ChannelMessageStatusStructure.Builder> status)The status of the channel message.ChannelMessage.Builderstatus(ChannelMessageStatusStructure status)The status of the channel message.ChannelMessage.BuildersubChannelId(String subChannelId)The ID of the SubChannel.ChannelMessage.Buildertarget(Collection<Target> target)The target of a message, a sender, a user, or a bot.ChannelMessage.Buildertarget(Consumer<Target.Builder>... target)The target of a message, a sender, a user, or a bot.ChannelMessage.Buildertarget(Target... target)The target of a message, a sender, a user, or a bot.ChannelMessage.Buildertype(String type)The message type.ChannelMessage.Buildertype(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 Detail
-
channelArn
ChannelMessage.Builder channelArn(String 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
ChannelMessage.Builder messageId(String 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
ChannelMessage.Builder content(String 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
ChannelMessage.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.
-
type
ChannelMessage.Builder type(String 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:
ChannelMessageType,ChannelMessageType
-
type
ChannelMessage.Builder type(ChannelMessageType 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:
ChannelMessageType,ChannelMessageType
-
createdTimestamp
ChannelMessage.Builder createdTimestamp(Instant 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
ChannelMessage.Builder lastEditedTimestamp(Instant 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
ChannelMessage.Builder lastUpdatedTimestamp(Instant 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
ChannelMessage.Builder sender(Identity 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
default ChannelMessage.Builder sender(Consumer<Identity.Builder> sender)
The message sender.
This is a convenience method that creates an instance of theIdentity.Builderavoiding the need to create one manually viaIdentity.builder().When the
Consumercompletes,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:
sender(Identity)
-
redacted
ChannelMessage.Builder redacted(Boolean 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
ChannelMessage.Builder persistence(String 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:
ChannelMessagePersistenceType,ChannelMessagePersistenceType
-
persistence
ChannelMessage.Builder persistence(ChannelMessagePersistenceType 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:
ChannelMessagePersistenceType,ChannelMessagePersistenceType
-
status
ChannelMessage.Builder status(ChannelMessageStatusStructure 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
default ChannelMessage.Builder status(Consumer<ChannelMessageStatusStructure.Builder> status)
The status of the channel message.
This is a convenience method that creates an instance of theChannelMessageStatusStructure.Builderavoiding the need to create one manually viaChannelMessageStatusStructure.builder().When the
Consumercompletes,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:
status(ChannelMessageStatusStructure)
-
messageAttributes
ChannelMessage.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
ChannelMessage.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
ChannelMessage.Builder contentType(String contentType)
The content type of the channel message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgsfor success responses andapplication/amz-chime-lex-errorfor 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-msgsfor success responses andapplication/amz-chime-lex-errorfor 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
ChannelMessage.Builder target(Collection<Target> 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
ChannelMessage.Builder target(Target... 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
ChannelMessage.Builder target(Consumer<Target.Builder>... 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.Builderavoiding the need to create one manually viaTarget.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#target(List.) - 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:
#target(java.util.Collection)
-
-