imtchat::IConversation

#include <IConversation.h>

Inherits iser::ISerializable.

Inherited by imtchat::CConversationComp [virtual].

Public Types
enum	ConversationType

Public Member Functions
virtual QByteArray	GetId () const =0
virtual void	SetId (const QByteArray &id)=0
virtual QString	GetName () const =0
virtual void	SetName (const QString &name)=0
virtual ConversationType	GetConversationType () const =0
virtual void	SetConversationType (ConversationType conversationType)=0
virtual QByteArrayList	GetParticipantIds () const =0
virtual void	SetParticipantIds (const QByteArrayList &participantIds)=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 QString	GetMetadata () const =0
virtual void	SetMetadata (const QString &metadata)=0

Detailed Description

Interface representing a chat conversation.

A conversation is a container for messages between participants. It can be a direct (1:1) chat, group, channel, or support conversation.

Definition at line 20 of file IConversation.h.

Member Enumeration Documentation

ConversationType

enum imtchat::IConversation::ConversationType

Conversation type — describes the kind of conversation.

Definition at line 26 of file IConversation.h.

Member Function Documentation

GetConversationType()

virtual ConversationType imtchat::IConversation::GetConversationType ( ) const

pure virtual

Get the conversation type.

GetCreatedAt()

virtual QString imtchat::IConversation::GetCreatedAt ( ) const

pure virtual

Get the ISO 8601 creation timestamp.

GetId()

virtual QByteArray imtchat::IConversation::GetId ( ) const

pure virtual

Get the unique conversation identifier.

GetMetadata()

virtual QString imtchat::IConversation::GetMetadata ( ) const

pure virtual

Get the JSON metadata string for this conversation.

GetName()

virtual QString imtchat::IConversation::GetName ( ) const

pure virtual

Get the display name of the conversation.

GetParticipantIds()

virtual QByteArrayList imtchat::IConversation::GetParticipantIds ( ) const

pure virtual

Get the list of participant user IDs.

GetUpdatedAt()

virtual QString imtchat::IConversation::GetUpdatedAt ( ) const

pure virtual

Get the ISO 8601 last-update timestamp.

SetConversationType()

virtual void imtchat::IConversation::SetConversationType ( ConversationType  conversationType )

pure virtual

Set the conversation type.

SetCreatedAt()

virtual void imtchat::IConversation::SetCreatedAt ( const QString &  createdAt )

pure virtual

Set the creation timestamp.

SetId()

virtual void imtchat::IConversation::SetId ( const QByteArray &  id )

pure virtual

Set the unique conversation identifier.

SetMetadata()

virtual void imtchat::IConversation::SetMetadata ( const QString &  metadata )

pure virtual

Set the JSON metadata string.

SetName()

virtual void imtchat::IConversation::SetName ( const QString &  name )

pure virtual

Set the display name of the conversation.

SetParticipantIds()

virtual void imtchat::IConversation::SetParticipantIds ( const QByteArrayList &  participantIds )

pure virtual

Set the list of participant user IDs.

SetUpdatedAt()

virtual void imtchat::IConversation::SetUpdatedAt ( const QString &  updatedAt )

pure virtual

Set the last-update timestamp.