Sendbird Chat SDK for Unity
SbBaseMessage

Base class for messages. More...

Inheritance diagram for SbBaseMessage:
SbAdminMessage SbFileMessage SbFileMessage SbUserMessage SbUserMessage

Public Member Functions

bool ApplyReactionEvent (SbReactionEvent inReactionEvent)
 
bool ApplyThreadInfoUpdateEvent (SbThreadInfoUpdateEvent inThreadInfoUpdateEvent)
 Applies SbThreadInfoUpdateEvent to a message. More...
 
bool IsResendable ()
 Whether the message is resendable. More...
 
void GetThreadedMessagesByTimestamp (long inTimestamp, SbThreadedMessageListParams inParams, SbThreadedMessageListHandler inCompletionHandler)
 Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesnt have replies, the result is an empty list. The result is passed to handler as list. More...
 

Properties

IReadOnlyList< SbMessageMetaArrayMetaArrays [get]
 All SbMessageMetaArray of the message. More...
 
SbAppleCriticalAlertOptions AppleCriticalAlertOptions [get]
 The apple critical alert options of the message. More...
 
SbChannelType ChannelType [get]
 The SbChannelType of the channel this message belongs to. More...
 
string ChannelUrl [get]
 The channel URL of the channel this message belongs to. More...
 
long CreatedAt [get]
 The creation time of the message in milliseconds. More...
 
string CustomType [get]
 The custom type of the message. More...
 
string Data [get]
 The custom data of the message. More...
 
int ErrorCode [get]
 The error code of them message if the sendingStatus is SbSendingStatus.Failed. More...
 
IDictionary< string, string > ExtendedMessage [get]
 The template for the message. More...
 
SbSendingStatus SendingStatus [get]
 The sending status of the message. More...
 
bool IsGroupChannel [get]
 Whether this message is from SbGroupChannel. More...
 
bool IsOpenChannel [get]
 Whether this message is from SbOpenChannel. More...
 
bool IsFeedChannel [get]
 Whether this message is from SbFeedChannel. More...
 
bool IsOperatorMessage [get]
 Whether the message was sent from an operator. More...
 
bool IsReplyToChannel [get]
 Determines whether the current message is a replied message and also a message was replied to the channel. More...
 
bool IsSilent [get]
 Checks whether the message is silent or not. More...
 
string MentionedMessageTemplate [get]
 The mentioned message template of the message. More...
 
IReadOnlyList< SbUserMentionedUsers [get]
 
SbMentionType MentionType [get]
 The mentioned users of the message. More...
 
string Message [get]
 The message text of the message. More...
 
SbBaseMessageCreateParams MessageCreateParams [get]
 The SbBaseMessageCreateParams object that used for sending this message For more details, Please refer SbUserMessage.MessageCreateParams, SbFileMessage.MessageCreateParams More...
 
long MessageId [get]
 The ID of the message. More...
 
int MessageSurvivalSeconds [get]
 The message's survival seconds. More...
 
SbOgMetaData OgMetaData [get]
 The SbOgMetaData of the message. More...
 
SbBaseMessage ParentMessage [get]
 
long ParentMessageId [get]
 The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message. More...
 
IReadOnlyList< SbReactionReactions [get]
 The reactions on the message. More...
 
string RequestId [get]
 The request ID of the message. More...
 
SbThreadInfo ThreadInfo [get]
 The thread info of the message. More...
 
long UpdatedAt [get]
 The updated time of the message in milliseconds. More...
 
SbSender Sender [get]
 The Sender of the message. If SendbirdChat.Options.UseMemberInfoInMessage is set true and this message belongs to a GroupChannel (not a super group channel), the sender information, such as nickname and profile url, is returned as the same with the GroupChannel.members. Otherwise, the sender information will be returned as the value of the message creation time. More...
 

Detailed Description

Base class for messages.

Since
4.0.0

Member Function Documentation

◆ ApplyReactionEvent()

bool ApplyReactionEvent ( SbReactionEvent  inReactionEvent)

Parameters
inReactionEvent
Returns
Since
4.0.0

◆ ApplyThreadInfoUpdateEvent()

bool ApplyThreadInfoUpdateEvent ( SbThreadInfoUpdateEvent  inThreadInfoUpdateEvent)

Applies SbThreadInfoUpdateEvent to a message.

Parameters
inThreadInfoUpdateEvent
Returns
Since
4.0.0

◆ GetThreadedMessagesByTimestamp()

void GetThreadedMessagesByTimestamp ( long  inTimestamp,
SbThreadedMessageListParams  inParams,
SbThreadedMessageListHandler  inCompletionHandler 
)

Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesnt have replies, the result is an empty list. The result is passed to handler as list.

Parameters
inTimestamp
inParams
inCompletionHandler
Since
4.0.0

◆ IsResendable()

bool IsResendable ( )

Whether the message is resendable.

Returns
Since
4.0.0

Property Documentation

◆ AppleCriticalAlertOptions

SbAppleCriticalAlertOptions AppleCriticalAlertOptions
get

The apple critical alert options of the message.

Since
4.0.0

◆ ChannelType

SbChannelType ChannelType
get

The SbChannelType of the channel this message belongs to.

Since
4.0.0

◆ ChannelUrl

string ChannelUrl
get

The channel URL of the channel this message belongs to.

Since
4.0.0

◆ CreatedAt

long CreatedAt
get

The creation time of the message in milliseconds.

Since
4.0.0

◆ CustomType

string CustomType
get

The custom type of the message.

Since
4.0.0

◆ Data

string Data
get

The custom data of the message.

Since
4.0.0

◆ ErrorCode

int ErrorCode
get

The error code of them message if the sendingStatus is SbSendingStatus.Failed.

Since
4.0.0

◆ ExtendedMessage

IDictionary<string, string> ExtendedMessage
get

The template for the message.

Since
4.0.0

◆ IsFeedChannel

bool IsFeedChannel
get

Whether this message is from SbFeedChannel.

Since
4.0.0

◆ IsGroupChannel

bool IsGroupChannel
get

Whether this message is from SbGroupChannel.

Since
4.0.0

◆ IsOpenChannel

bool IsOpenChannel
get

Whether this message is from SbOpenChannel.

Since
4.0.0

◆ IsOperatorMessage

bool IsOperatorMessage
get

Whether the message was sent from an operator.

Since
4.0.0

◆ IsReplyToChannel

bool IsReplyToChannel
get

Determines whether the current message is a replied message and also a message was replied to the channel.

Since
4.0.0

◆ IsSilent

bool IsSilent
get

Checks whether the message is silent or not.

Since
4.0.0

◆ MentionedMessageTemplate

string MentionedMessageTemplate
get

The mentioned message template of the message.

Since
4.0.0

◆ MentionedUsers

IReadOnlyList<SbUser> MentionedUsers
get

Since
4.0.0

◆ MentionType

SbMentionType MentionType
get

The mentioned users of the message.

Since
4.0.0

◆ Message

string Message
get

The message text of the message.

Since
4.0.0

◆ MessageCreateParams

SbBaseMessageCreateParams MessageCreateParams
get

The SbBaseMessageCreateParams object that used for sending this message For more details, Please refer SbUserMessage.MessageCreateParams, SbFileMessage.MessageCreateParams

Since
4.0.0

◆ MessageId

long MessageId
get

The ID of the message.

Since
4.0.0

◆ MessageSurvivalSeconds

int MessageSurvivalSeconds
get

The message's survival seconds.

Since
4.0.0

◆ MetaArrays

IReadOnlyList<SbMessageMetaArray> MetaArrays
get

All SbMessageMetaArray of the message.

Since
4.0.0

◆ OgMetaData

SbOgMetaData OgMetaData
get

The SbOgMetaData of the message.

Since
4.0.0

◆ ParentMessage

SbBaseMessage ParentMessage
get

Since
4.0.0

◆ ParentMessageId

long ParentMessageId
get

The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message.

Since
4.0.0

◆ Reactions

IReadOnlyList<SbReaction> Reactions
get

The reactions on the message.

Since
4.0.0

◆ RequestId

string RequestId
get

The request ID of the message.

Since
4.0.0

◆ Sender

SbSender Sender
get

The Sender of the message. If SendbirdChat.Options.UseMemberInfoInMessage is set true and this message belongs to a GroupChannel (not a super group channel), the sender information, such as nickname and profile url, is returned as the same with the GroupChannel.members. Otherwise, the sender information will be returned as the value of the message creation time.

Since
4.0.0

◆ SendingStatus

SbSendingStatus SendingStatus
get

The sending status of the message.

Since
4.0.0

◆ ThreadInfo

SbThreadInfo ThreadInfo
get

The thread info of the message.

Since
4.0.0

◆ UpdatedAt

long UpdatedAt
get

The updated time of the message in milliseconds.

Since
4.0.0