public static interface SendChannelMessageRequest.Builder extends ChimeSdkMessagingRequest.Builder, SdkPojo, CopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>
| Modifier and Type | Method and Description |
|---|---|
SendChannelMessageRequest.Builder |
channelArn(String channelArn)
The ARN of the channel.
|
SendChannelMessageRequest.Builder |
chimeBearer(String chimeBearer)
The ARN of the
AppInstanceUser or AppInstanceBot that makes the API call. |
SendChannelMessageRequest.Builder |
clientRequestToken(String clientRequestToken)
The
Idempotency token for each client request. |
SendChannelMessageRequest.Builder |
content(String content)
The content of the channel message.
|
SendChannelMessageRequest.Builder |
contentType(String contentType)
The content type of the channel message.
|
SendChannelMessageRequest.Builder |
messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
The attributes for the message, used for message filtering along with a
FilterRule defined in
the PushNotificationPreferences. |
SendChannelMessageRequest.Builder |
metadata(String metadata)
The optional metadata for each message.
|
SendChannelMessageRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
SendChannelMessageRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
SendChannelMessageRequest.Builder |
persistence(ChannelMessagePersistenceType persistence)
Boolean that controls whether the message is persisted on the back end.
|
SendChannelMessageRequest.Builder |
persistence(String persistence)
Boolean that controls whether the message is persisted on the back end.
|
default SendChannelMessageRequest.Builder |
pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification)
The push notification configuration of the message.
|
SendChannelMessageRequest.Builder |
pushNotification(PushNotificationConfiguration pushNotification)
The push notification configuration of the message.
|
SendChannelMessageRequest.Builder |
subChannelId(String subChannelId)
The ID of the SubChannel in the request.
|
SendChannelMessageRequest.Builder |
target(Collection<Target> target)
The target of a message.
|
SendChannelMessageRequest.Builder |
target(Consumer<Target.Builder>... target)
The target of a message.
|
SendChannelMessageRequest.Builder |
target(Target... target)
The target of a message.
|
SendChannelMessageRequest.Builder |
type(ChannelMessageType type)
The type of message,
STANDARD or CONTROL. |
SendChannelMessageRequest.Builder |
type(String type)
The type of message,
STANDARD or CONTROL. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildSendChannelMessageRequest.Builder channelArn(String channelArn)
The ARN of the channel.
channelArn - The ARN of the channel.SendChannelMessageRequest.Builder content(String content)
The content of the channel message.
content - The content of the channel message.SendChannelMessageRequest.Builder type(String type)
The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you
can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
type - The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
and you can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
ChannelMessageType,
ChannelMessageTypeSendChannelMessageRequest.Builder type(ChannelMessageType type)
The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you
can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
type - The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
and you can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
ChannelMessageType,
ChannelMessageTypeSendChannelMessageRequest.Builder persistence(String persistence)
Boolean that controls whether the message is persisted on the back end. Required.
persistence - Boolean that controls whether the message is persisted on the back end. Required.ChannelMessagePersistenceType,
ChannelMessagePersistenceTypeSendChannelMessageRequest.Builder persistence(ChannelMessagePersistenceType persistence)
Boolean that controls whether the message is persisted on the back end. Required.
persistence - Boolean that controls whether the message is persisted on the back end. Required.ChannelMessagePersistenceType,
ChannelMessagePersistenceTypeSendChannelMessageRequest.Builder metadata(String metadata)
The optional metadata for each message.
metadata - The optional metadata for each message.SendChannelMessageRequest.Builder clientRequestToken(String clientRequestToken)
The Idempotency token for each client request.
clientRequestToken - The Idempotency token for each client request.SendChannelMessageRequest.Builder chimeBearer(String chimeBearer)
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
chimeBearer - The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.SendChannelMessageRequest.Builder pushNotification(PushNotificationConfiguration pushNotification)
The push notification configuration of the message.
pushNotification - The push notification configuration of the message.default SendChannelMessageRequest.Builder pushNotification(Consumer<PushNotificationConfiguration.Builder> pushNotification)
The push notification configuration of the message.
This is a convenience method that creates an instance of thePushNotificationConfiguration.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).
pushNotification - a consumer that will call methods on PushNotificationConfiguration.BuilderpushNotification(PushNotificationConfiguration)SendChannelMessageRequest.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
The attributes for the message, used for message filtering along with a FilterRule defined in
the PushNotificationPreferences.
messageAttributes - The attributes for the message, used for message filtering along with a FilterRule
defined in the PushNotificationPreferences.SendChannelMessageRequest.Builder subChannelId(String subChannelId)
The ID of the SubChannel in the request.
subChannelId - The ID of the SubChannel in the request.SendChannelMessageRequest.Builder contentType(String contentType)
The content type of the channel message.
contentType - The content type of the channel message.SendChannelMessageRequest.Builder target(Collection<Target> target)
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. 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.
target - The target of a message. Must be a member of the channel, such as another user, a bot, or the sender.
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.SendChannelMessageRequest.Builder target(Target... target)
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. 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.
target - The target of a message. Must be a member of the channel, such as another user, a bot, or the sender.
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.SendChannelMessageRequest.Builder target(Consumer<Target.Builder>... target)
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. 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 via Target.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #target(List.
target - a consumer that will call methods on
Target.Builder#target(java.util.Collection) SendChannelMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderSendChannelMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.