SBDBaseMessage Class Reference

#include <SBDBaseMessage.h>

Inheritance diagram for SBDBaseMessage:

Public Member Functions
bool	IsOpenChannel ()
bool	IsGroupChannel ()
std::vector< SBDMessageMetaArray >	GetMetaArraysWithKeys (const std::vector< std::wstring > &metaarraykeys)

Public Attributes
SBDMessageType	message_type
uint64_t	message_id
std::wstring	channel_url
int64_t	created_at
int64_t	updated_at
std::wstring	channel_type
SBDMentionType	mention_type
std::vector< SBDUser >	mentioned_users
std::vector< SBDMessageMetaArray >	meta_arrays

Protected Member Functions
	SBDBaseMessage (const std::string &dict)

Detailed Description

The SBDBaseMessage class represents the base message which is generated by a user or an admin. The SBDUserMessage, the SBDFileMessage and the SBDAdminMessage are derived from this class.

Member Function Documentation

GetMetaArraysWithKeys()

std::vector< SBDMessageMetaArray > SBDBaseMessage::GetMetaArraysWithKeys

(

const std::vector< std::wstring > &

metaarraykeys

)

GetMetaArraysWithKeys

Returns

Returns an array of meta arrays with keys.

IsGroupChannel()

bool SBDBaseMessage::IsGroupChannel

(

)

Checks the channel type is group channel or not.

Returns

Returns true, when this is group channel.

IsOpenChannel()

bool SBDBaseMessage::IsOpenChannel

(

)

Checks the channel type is open channel or not.

Returns

Returns true, when this is open channel.

Member Data Documentation

channel_type

std::wstring SBDBaseMessage::channel_type

The type of channel. If this message belongs to a open channel, the value is "open" string. If this channel belongs to a group channel, then the value is "group".

channel_url

std::wstring SBDBaseMessage::channel_url

Channel URL which has this message.

created_at

int64_t SBDBaseMessage::created_at

Message created time in millisecond(UTC).

mention_type

SBDMentionType SBDBaseMessage::mention_type

mention_type

mentioned_users

std::vector<SBDUser> SBDBaseMessage::mentioned_users

Can mention to specific users. If sends a message with this field, the message will be arrived to mentioned users. The default value is null.

message_id

uint64_t SBDBaseMessage::message_id

Unique message ID.

message_type

SBDMessageType SBDBaseMessage::message_type

The type of message.

meta_arrays

std::vector<SBDMessageMetaArray> SBDBaseMessage::meta_arrays

Gets an array of meta arrays sorted by chronological order.

updated_at

int64_t SBDBaseMessage::updated_at

Message updated time in millisecond(UTC).