Struct Item

#[non_exhaustive]
pub struct Item {
    pub absolute_time: Option<String>,
    pub content: Option<String>,
    pub content_type: Option<String>,
    pub id: Option<String>,
    pub type: Option<ChatItemType>,
    pub participant_id: Option<String>,
    pub display_name: Option<String>,
    pub participant_role: Option<ParticipantRole>,
    pub attachments: Option<Vec<AttachmentItem>>,
    pub message_metadata: Option<MessageMetadata>,
    pub related_contact_id: Option<String>,
    pub contact_id: Option<String>,
}

An item - message or event - that has been sent.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

absolute_time: Option<String>

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: Option<String>

The content of the message or event.

content_type: Option<String>

The type of content of the item.

id: Option<String>

The ID of the item.

type: Option<ChatItemType>

Type of the item: message or event.

participant_id: Option<String>

The ID of the sender in the session.

display_name: Option<String>

The chat display name of the sender.

participant_role: Option<ParticipantRole>

The role of the sender. For example, is it a customer, agent, or system.

attachments: Option<Vec<AttachmentItem>>

Provides information about the attachments.

message_metadata: Option<MessageMetadata>

The metadata related to the message. Currently this supports only information related to message receipts.

related_contact_id: Option<String>

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.

contact_id: Option<String>

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.

Implementations

impl Item

pub fn absolute_time(&self) -> Option<&str>

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.

pub fn content(&self) -> Option<&str>

The content of the message or event.

pub fn content_type(&self) -> Option<&str>

The type of content of the item.

pub fn id(&self) -> Option<&str>

The ID of the item.

pub fn type(&self) -> Option<&ChatItemType>

Type of the item: message or event.

pub fn participant_id(&self) -> Option<&str>

The ID of the sender in the session.

pub fn display_name(&self) -> Option<&str>

The chat display name of the sender.

pub fn participant_role(&self) -> Option<&ParticipantRole>

The role of the sender. For example, is it a customer, agent, or system.

pub fn attachments(&self) -> &[AttachmentItem]

Provides information about the attachments.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none().

pub fn message_metadata(&self) -> Option<&MessageMetadata>

The metadata related to the message. Currently this supports only information related to message receipts.

pub fn related_contact_id(&self) -> Option<&str>

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.

pub fn contact_id(&self) -> Option<&str>

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.

impl Item

pub fn builder() -> ItemBuilder

Creates a new builder-style object to manufacture Item.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Item

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Item

fn eq(&self, other: &Item) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Item