Class Item
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Item.Builder,
Item>
An item - message or event - that has been sent.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The time when the message or event was sent.final List
<AttachmentItem> Provides information about the attachments.static Item.Builder
builder()
final String
The contactId on which the transcript item was originally sent.final String
content()
The content of the message or event.final String
The type of content of the item.final String
The chat display name of the sender.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) final boolean
For responses, this returns true if the service returned a value for the Attachments property.final int
hashCode()
final String
id()
The ID of the item.final MessageMetadata
The metadata related to the message.final String
The ID of the sender in the session.final ParticipantRole
The role of the sender.final String
The role of the sender.final String
The contactId on which the transcript item was originally sent.static Class
<? extends Item.Builder> 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 ChatItemType
type()
Type of the item: message or event.final String
Type of the item: message or event.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
absoluteTime
The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
- Returns:
- The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
-
content
The content of the message or event.
- Returns:
- The content of the message or event.
-
contentType
The type of content of the item.
- Returns:
- The type of content of the item.
-
id
The ID of the item.
- Returns:
- The ID of the item.
-
type
Type of the item: message or event.
If the service returns an enum value that is not available in the current SDK version,
type
will returnChatItemType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Type of the item: message or event.
- See Also:
-
typeAsString
Type of the item: message or event.
If the service returns an enum value that is not available in the current SDK version,
type
will returnChatItemType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Type of the item: message or event.
- See Also:
-
participantId
The ID of the sender in the session.
- Returns:
- The ID of the sender in the session.
-
displayName
The chat display name of the sender.
- Returns:
- The chat display name of the sender.
-
participantRole
The role of the sender. For example, is it a customer, agent, or system.
If the service returns an enum value that is not available in the current SDK version,
participantRole
will returnParticipantRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantRoleAsString()
.- Returns:
- The role of the sender. For example, is it a customer, agent, or system.
- See Also:
-
participantRoleAsString
The role of the sender. For example, is it a customer, agent, or system.
If the service returns an enum value that is not available in the current SDK version,
participantRole
will returnParticipantRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantRoleAsString()
.- Returns:
- The role of the sender. For example, is it a customer, agent, or system.
- See Also:
-
hasAttachments
public final boolean hasAttachments()For responses, this returns true if the service returned a value for the Attachments 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. -
attachments
Provides information about the attachments.
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
hasAttachments()
method.- Returns:
- Provides information about the attachments.
-
messageMetadata
The metadata related to the message. Currently this supports only information related to message receipts.
- Returns:
- The metadata related to the message. Currently this supports only information related to message receipts.
-
contactId
The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
- Returns:
- The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
-
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<Item.Builder,
Item> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-