Class Item
- java.lang.Object
-
- software.amazon.awssdk.services.connectparticipant.model.Item
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Item.Builder,Item>
@Generated("software.amazon.awssdk:codegen") public final class Item extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Item.Builder,Item>
An item - message or event - that has been sent.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceItem.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringabsoluteTime()The time when the message or event was sent.List<AttachmentItem>attachments()Provides information about the attachments.static Item.Builderbuilder()StringcontactId()The contactId on which the transcript item was originally sent.Stringcontent()The content of the message or event.StringcontentType()The type of content of the item.StringdisplayName()The chat display name of the sender.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttachments()For responses, this returns true if the service returned a value for the Attachments property.inthashCode()Stringid()The ID of the item.MessageMetadatamessageMetadata()The metadata related to the message.StringparticipantId()The ID of the sender in the session.ParticipantRoleparticipantRole()The role of the sender.StringparticipantRoleAsString()The role of the sender.StringrelatedContactId()The contactId on which the transcript item was originally sent.List<SdkField<?>>sdkFields()static Class<? extends Item.Builder>serializableBuilderClass()Item.BuildertoBuilder()StringtoString()Returns a string representation of this object.ChatItemTypetype()Type of the item: message or event.StringtypeAsString()Type of the item: message or event.-
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
-
absoluteTime
public final String 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
public final String content()
The content of the message or event.
- Returns:
- The content of the message or event.
-
contentType
public final String contentType()
The type of content of the item.
- Returns:
- The type of content of the item.
-
id
public final String id()
The ID of the item.
- Returns:
- The ID of the item.
-
type
public final ChatItemType type()
Type of the item: message or event.
If the service returns an enum value that is not available in the current SDK version,
typewill 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:
ChatItemType
-
typeAsString
public final String typeAsString()
Type of the item: message or event.
If the service returns an enum value that is not available in the current SDK version,
typewill 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:
ChatItemType
-
participantId
public final String participantId()
The ID of the sender in the session.
- Returns:
- The ID of the sender in the session.
-
displayName
public final String displayName()
The chat display name of the sender.
- Returns:
- The chat display name of the sender.
-
participantRole
public final ParticipantRole 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,
participantRolewill 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:
ParticipantRole
-
participantRoleAsString
public final String 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,
participantRolewill 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:
ParticipantRole
-
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
public final List<AttachmentItem> 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
public final MessageMetadata 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.
-
relatedContactId
public final String relatedContactId()
The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
- Returns:
- The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
-
contactId
public final String 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
public Item.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Item.Builder,Item>
-
builder
public static Item.Builder builder()
-
serializableBuilderClass
public static Class<? extends Item.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-