Class SendChannelMessageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SendChannelMessageRequest.Builder,
SendChannelMessageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the channel.final String
The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.final String
TheIdempotency
token for each client request.final String
content()
The content of the channel message.final String
The content type of the channel message.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MessageAttributes property.final boolean
For responses, this returns true if the service returned a value for the Target property.final Map
<String, MessageAttributeValue> The attributes for the message, used for message filtering along with aFilterRule
defined in thePushNotificationPreferences
.final String
metadata()
The optional metadata for each message.Boolean that controls whether the message is persisted on the back end.final String
Boolean that controls whether the message is persisted on the back end.The push notification configuration of the message.static Class
<? extends SendChannelMessageRequest.Builder> final String
The ID of the SubChannel in the request.target()
The target of a message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ChannelMessageType
type()
The type of message,STANDARD
orCONTROL
.final String
The type of message,STANDARD
orCONTROL
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelArn
The ARN of the channel.
- Returns:
- The ARN of the channel.
-
content
The content of the channel message.
- Returns:
- The content of the channel message.
-
type
The type of message,
STANDARD
orCONTROL
.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.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of message,
STANDARD
orCONTROL
.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. - See Also:
-
typeAsString
The type of message,
STANDARD
orCONTROL
.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.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of message,
STANDARD
orCONTROL
.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. - See Also:
-
persistence
Boolean that controls whether the message is persisted on the back end. Required.
If the service returns an enum value that is not available in the current SDK version,
persistence
will returnChannelMessagePersistenceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompersistenceAsString()
.- Returns:
- Boolean that controls whether the message is persisted on the back end. Required.
- See Also:
-
persistenceAsString
Boolean that controls whether the message is persisted on the back end. Required.
If the service returns an enum value that is not available in the current SDK version,
persistence
will returnChannelMessagePersistenceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompersistenceAsString()
.- Returns:
- Boolean that controls whether the message is persisted on the back end. Required.
- See Also:
-
metadata
The optional metadata for each message.
- Returns:
- The optional metadata for each message.
-
clientRequestToken
The
Idempotency
token for each client request.- Returns:
- The
Idempotency
token for each client request.
-
chimeBearer
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.- Returns:
- The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.
-
pushNotification
The push notification configuration of the message.
- Returns:
- The push notification configuration of the message.
-
hasMessageAttributes
public final boolean hasMessageAttributes()For responses, this returns true if the service returned a value for the MessageAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
messageAttributes
The attributes for the message, used for message filtering along with a
FilterRule
defined in thePushNotificationPreferences
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMessageAttributes()
method.- Returns:
- The attributes for the message, used for message filtering along with a
FilterRule
defined in thePushNotificationPreferences
.
-
subChannelId
The ID of the SubChannel in the request.
- Returns:
- The ID of the SubChannel in the request.
-
contentType
The content type of the channel message.
- Returns:
- The content type of the channel message.
-
hasTarget
public final boolean hasTarget()For responses, this returns true if the service returned a value for the Target property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTarget()
method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SendChannelMessageRequest.Builder,
SendChannelMessageRequest> - Specified by:
toBuilder
in classChimeSdkMessagingRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-