ImagingTools Core SDK
Public Types | Public Member Functions | List of all members
imtchat::IChatMessageabstract

#include <IChatMessage.h>

Inherits iser::ISerializable.

Inherited by imtchat::CChatMessageComp [virtual].

Public Types

enum  MessageStatus
 

Public Member Functions

virtual QByteArray GetId () const =0
 
virtual void SetId (const QByteArray &id)=0
 
virtual QByteArray GetConversationId () const =0
 
virtual void SetConversationId (const QByteArray &conversationId)=0
 
virtual QByteArray GetSenderId () const =0
 
virtual void SetSenderId (const QByteArray &senderId)=0
 
virtual QString GetContent () const =0
 
virtual void SetContent (const QString &content)=0
 
virtual MessageStatus GetStatus () const =0
 
virtual void SetStatus (MessageStatus status)=0
 
virtual QString GetCreatedAt () const =0
 
virtual void SetCreatedAt (const QString &createdAt)=0
 
virtual QString GetUpdatedAt () const =0
 
virtual void SetUpdatedAt (const QString &updatedAt)=0
 
virtual QByteArrayList GetEntityReferences () const =0
 
virtual void SetEntityReferences (const QByteArrayList &entityReferences)=0
 
virtual QByteArrayList GetAttachmentIds () const =0
 
virtual void SetAttachmentIds (const QByteArrayList &attachmentIds)=0
 

Detailed Description

Interface representing a single chat message.

Messages belong to a conversation, are sent by a user, and can optionally embed entity references and attachment IDs.

Definition at line 20 of file IChatMessage.h.

Member Enumeration Documentation

◆ MessageStatus

Message delivery/read status.

Definition at line 26 of file IChatMessage.h.

Member Function Documentation

◆ GetAttachmentIds()

virtual QByteArrayList imtchat::IChatMessage::GetAttachmentIds ( ) const
pure virtual

Get the list of attachment IDs associated with this message.

◆ GetContent()

virtual QString imtchat::IChatMessage::GetContent ( ) const
pure virtual

Get the message text content.

◆ GetConversationId()

virtual QByteArray imtchat::IChatMessage::GetConversationId ( ) const
pure virtual

Get the conversation this message belongs to.

◆ GetCreatedAt()

virtual QString imtchat::IChatMessage::GetCreatedAt ( ) const
pure virtual

Get the ISO 8601 creation timestamp.

◆ GetEntityReferences()

virtual QByteArrayList imtchat::IChatMessage::GetEntityReferences ( ) const
pure virtual

Get the list of entity reference IDs linked to this message.

◆ GetId()

virtual QByteArray imtchat::IChatMessage::GetId ( ) const
pure virtual

Get the unique message identifier.

◆ GetSenderId()

virtual QByteArray imtchat::IChatMessage::GetSenderId ( ) const
pure virtual

Get the identifier of the user who sent this message.

◆ GetStatus()

virtual MessageStatus imtchat::IChatMessage::GetStatus ( ) const
pure virtual

Get the delivery/read status.

◆ GetUpdatedAt()

virtual QString imtchat::IChatMessage::GetUpdatedAt ( ) const
pure virtual

Get the ISO 8601 last-update timestamp.

◆ SetAttachmentIds()

virtual void imtchat::IChatMessage::SetAttachmentIds ( const QByteArrayList &  attachmentIds)
pure virtual

Set the attachment IDs.

◆ SetContent()

virtual void imtchat::IChatMessage::SetContent ( const QString &  content)
pure virtual

Set the message text content.

◆ SetConversationId()

virtual void imtchat::IChatMessage::SetConversationId ( const QByteArray &  conversationId)
pure virtual

Set the conversation identifier.

◆ SetCreatedAt()

virtual void imtchat::IChatMessage::SetCreatedAt ( const QString &  createdAt)
pure virtual

Set the creation timestamp.

◆ SetEntityReferences()

virtual void imtchat::IChatMessage::SetEntityReferences ( const QByteArrayList &  entityReferences)
pure virtual

Set the entity reference IDs.

◆ SetId()

virtual void imtchat::IChatMessage::SetId ( const QByteArray &  id)
pure virtual

Set the unique message identifier.

◆ SetSenderId()

virtual void imtchat::IChatMessage::SetSenderId ( const QByteArray &  senderId)
pure virtual

Set the sender identifier.

◆ SetStatus()

virtual void imtchat::IChatMessage::SetStatus ( MessageStatus  status)
pure virtual

Set the delivery/read status.

◆ SetUpdatedAt()

virtual void imtchat::IChatMessage::SetUpdatedAt ( const QString &  updatedAt)
pure virtual

Set the last-update timestamp.