ChannelMessageSummary (AWS Java SDK :: Services :: Chime SDK Messaging 2.21.4 API)

java.lang.Object
- software.amazon.awssdk.services.chimesdkmessaging.model.ChannelMessageSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ChannelMessageSummary.Builder,ChannelMessageSummary>

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

Summary of the messages in a Channel.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ChannelMessageSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ChannelMessageSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ChannelMessageSummary.Builder`	`builder()`
`String`	`content()` The content of the channel message.
`String`	`contentType()` The content type of the channel message listed in the summary.
`Instant`	`createdTimestamp()` The time at which the message summary was created.
`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.
`boolean`	`hasTarget()` For responses, this returns true if the service returned a value for the Target property.
`Instant`	`lastEditedTimestamp()` The time at which a message was last edited.
`Instant`	`lastUpdatedTimestamp()` The time at which a message was last updated.
`Map<String,MessageAttributeValue>`	`messageAttributes()` The attributes for the channel message.
`String`	`messageId()` The ID of the message.
`String`	`metadata()` The metadata of the message.
`Boolean`	`redacted()` Indicates whether a message was redacted.
`List<SdkField<?>>`	`sdkFields()`
`Identity`	`sender()` The message sender.
`static Class<? extends ChannelMessageSummary.Builder>`	`serializableBuilderClass()`
`ChannelMessageStatusStructure`	`status()` The message status.
`List<Target>`	`target()` The target of a message, a sender, a user, or a bot.
`ChannelMessageSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ChannelMessageType`	`type()` The type of message.
`String`	`typeAsString()` The type of message.

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 ID of the message.
    
    Returns:
    
    The ID of the message.
  - content
```
public final 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.
    
    Returns:
    
    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.
  - metadata
```
public final String metadata()
```
    The metadata of the message.
    
    Returns:
    
    The metadata of the message.
  - type
```
public final ChannelMessageType type()
```
    The type of message.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ChannelMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of message.
    
    See Also:
    
    ChannelMessageType
  - typeAsString
```
public final String typeAsString()
```
    The type of message.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ChannelMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of message.
    
    See Also:
    
    ChannelMessageType
  - createdTimestamp
```
public final Instant createdTimestamp()
```
    The time at which the message summary was created.
    
    Returns:
    
    The time at which the message summary was created.
  - lastUpdatedTimestamp
```
public final Instant lastUpdatedTimestamp()
```
    The time at which a message was last updated.
    
    Returns:
    
    The time at which a message was last updated.
  - lastEditedTimestamp
```
public final Instant lastEditedTimestamp()
```
    The time at which a message was last edited.
    
    Returns:
    
    The time at which a message was last edited.
  - sender
```
public final Identity sender()
```
    The message sender.
    
    Returns:
    
    The message sender.
  - redacted
```
public final Boolean redacted()
```
    Indicates whether a message was redacted.
    
    Returns:
    
    Indicates whether a message was redacted.
  - status
```
public final ChannelMessageStatusStructure status()
```
    The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
    
    Returns:
    
    The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
  - 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.
  - contentType
```
public final String contentType()
```
    The content type of the channel message listed in the summary. 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 channel message listed in the summary. 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.
  - 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 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.
  - target
```
public final List<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.
    
    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, 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.
  - toBuilder
```
public ChannelMessageSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ChannelMessageSummary.Builder,ChannelMessageSummary>
  - builder
```
public static ChannelMessageSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ChannelMessageSummary.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

Class ChannelMessageSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

messageId

content

metadata

type

typeAsString

createdTimestamp

lastUpdatedTimestamp

lastEditedTimestamp

sender

redacted

status

hasMessageAttributes

messageAttributes

contentType

hasTarget

target

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields