software.amazon.awssdk.services.chimesdkmessaging.model

Class ChannelMessageCallback

java.lang.Object

software.amazon.awssdk.services.chimesdkmessaging.model.ChannelMessageCallback

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>

@Generated(value="software.amazon.awssdk:codegen")
public final class ChannelMessageCallback
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>

Stores information about a callback.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelMessageCallback.Builder

Method Summary

Modifier and Type	Method and Description
static ChannelMessageCallback.Builder	builder()
String	content() The message content.
String	contentType() The content type of the call-back message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMessageAttributes() For responses, this returns true if the service returned a value for the MessageAttributes property.
Map<String,MessageAttributeValue>	messageAttributes() The attributes for the channel message.
String	messageId() The message ID.
String	metadata() The message metadata.
PushNotificationConfiguration	pushNotification() The push notification configuration of the message.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelMessageCallback.Builder>	serializableBuilderClass()
String	subChannelId() The ID of the SubChannel.
ChannelMessageCallback.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

messageId

public final String messageId()

The message ID.

Returns:

The message ID.

content

public final 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.

Returns:

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.

metadata

public final String metadata()

The message metadata.

Returns:

The message metadata.

pushNotification

public final PushNotificationConfiguration 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 the isEmpty() 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

public final 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.

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 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.

subChannelId

public final String subChannelId()

The ID of the SubChannel.

Returns:

The ID of the SubChannel.

contentType

public final 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.

Returns:

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.

toBuilder

public ChannelMessageCallback.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelMessageCallback.Builder,ChannelMessageCallback>

builder

public static ChannelMessageCallback.Builder builder()

serializableBuilderClass

public static Class<? extends ChannelMessageCallback.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo