SbBaseChannel

Objects representing a channel. More...

Inheritance diagram for SbBaseChannel:

Public Member Functions
SbUserMessage	SendUserMessage (string inMessage, SbUserMessageHandler inCompletionHandler)
	Sends a user message. More...
SbUserMessage	SendUserMessage (SbUserMessageCreateParams inUserMessageCreateParams, SbUserMessageHandler inCompletionHandler)
	Sends a string message of params. More...
SbUserMessage	ResendUserMessage (SbUserMessage inUserMessage, SbUserMessageHandler inCompletionHandler)
	Attempts to resend a failed user message received by the failure callback. Only failed message MUST be passed, not a succeeded message or a pending message. More...
void	UpdateUserMessage (long inMessageId, SbUserMessageUpdateParams inParams, SbUserMessageHandler inCompletionHandler)
	Updates a user message. The text message, data, custom type from user message params can be updated. More...
SbUserMessage	CopyUserMessage (SbUserMessage inUserMessage, SbBaseChannel inToTargetChannel, SbUserMessageHandler inCompletionHandler)
	Copies a user message to the target channel. More...
void	TranslateUserMessage (SbUserMessage inUserMessage, List< string > inTargetLanguages, SbUserMessageHandler inCompletionHandler)
	Requests to translate the text message into the target languages. More...
SbFileMessage	SendFileMessage (SbFileMessageCreateParams inFileMessageCreateParams, SbMultiProgressHandler inProgressHandler, SbFileMessageHandler inCompletionHandler)
	Sends a file message with file or file URL of params with progress. If the params has a binary file, it will upload data to Sendbird storage. If not, the params has a file url, it will send a message with file url. More...
SbFileMessage	ResendFileMessage (SbFileMessage inFileMessage, SbFileInfo inFileInfo, SbMultiProgressHandler inProgressHandler, SbFileMessageHandler inCompletionHandler)
	Attempts to resend a failed file message received by the failure callback. More...
void	UpdateFileMessage (long inMessageId, SbFileMessageUpdateParams inParams, SbFileMessageHandler inCompletionHandler)
	Updates a file message. The data, custom type from file message params can be updated. More...
SbFileMessage	CopyFileMessage (SbFileMessage inFileMessage, SbBaseChannel inToTargetChannel, SbFileMessageHandler inCompletionHandler)
	Copies a file message to the target channel. More...
bool	CancelUploadingFileMessage (string inRequestId)
	Cancels an ongoing FileMessage upload. More...
void	DeleteMessage (long inMessageId, SbErrorHandler inCompletionHandler)
	Deletes a message with message ID. More...
void	GetMessagesByTimestamp (long inTimestamp, SbMessageListParams inParams, SbMessageListHandler inCompletionHandler)
	Retrieves previous or next messages based on the timestamp in a specific channel. The result is passed to handler as list. More...
void	GetMessagesByMessageId (long inMessageId, SbMessageListParams inParams, SbMessageListHandler inCompletionHandler)
	Retrieves previous or next messages based on the message ID in a specific channel. The result is passed to handler as list. More...
void	CreateMetaData (Dictionary< string, string > inMetaData, SbMetaDataHandler inCompletionHandler)
	Creates meta data. This can be used to customize the channel. More...
void	GetMetaData (List< string > inKeys, SbMetaDataHandler inCompletionHandler)
	Gets the meta data for the channel. More...
void	GetAllMetaData (SbMetaDataHandler inCompletionHandler)
	Gets all meta data for the channel. More...
void	UpdateMetaData (Dictionary< string, string > inMetaData, SbMetaDataHandler inCompletionHandler)
	Updates the meta data for the channel. More...
void	DeleteMetaData (string inKey, SbErrorHandler inCompletionHandler)
	Deletes meta data with key for the channel. More...
void	DeleteAllMetaData (SbErrorHandler inCompletionHandler)
	Deletes all meta data for the channel. More...
void	CreateMetaCounters (Dictionary< string, int > inMetaCounters, SbMetaCountersHandler inCompletionHandler)
	Creates the meta counters for the channel. More...
void	GetMetaCounters (List< string > inKeys, SbMetaCountersHandler inCompletionHandler)
	Gets the meta counters with keys for the channel. More...
void	GetAllMetaCounters (SbMetaCountersHandler inCompletionHandler)
void	UpdateMetaCounters (Dictionary< string, int > inMetaCounters, SbMetaCountersHandler inCompletionHandler)
	Gets all meta counters for the channel. More...
void	IncreaseMetaCounters (Dictionary< string, int > inMetaCounters, SbMetaCountersHandler inCompletionHandler)
	Increases the meta counters for the channel. More...
void	DecreaseMetaCounters (Dictionary< string, int > inMetaCounters, SbMetaCountersHandler inCompletionHandler)
	Decreases the meta counters for the channel. More...
void	DeleteMetaCounters (string inKey, SbErrorHandler inCompletionHandler)
	Deletes the meta counters with key for the channel. More...
void	DeleteAllMetaCounters (SbErrorHandler inCompletionHandler)
	Deletes all meta counters for the channel. More...
SbOperatorListQuery	CreateOperatorListQuery (SbOperatorListQueryParams inParams=null)
	Creates a query instance to get the operator list from this channel. More...
SbPreviousMessageListQuery	CreatePreviousMessageListQuery (SbPreviousMessageListQueryParams inParams=null)
	Creates previous message list query for this channel. More...
void	GetMessageChangeLogsSinceTimestamp (long inTimestamp, SbMessageChangeLogsParams inParams, SbMessageChangeLogHandler inCompletionHandler)
	Requests message change logs after given timestamp. The result is passed to handler. More...
void	GetMessageChangeLogsSinceToken (string inToken, SbMessageChangeLogsParams inParams, SbMessageChangeLogHandler inCompletionHandler)
	Requests message change logs after given token. The result is passed to handler. More...
SbBannedUserListQuery	CreateBannedUserListQuery (SbBannedUserListQueryParams inParams)
	Creates a query instance for banned user list of the channel. More...
SbMutedUserListQuery	CreateMutedUserListQuery (SbMutedUserListQueryParams inParams)
	Creates a query instance for getting muted user list of the channel instance. More...
void	BanUser (string inUserId, int inSeconds, string inDescription, SbErrorHandler inCompletionHandler)
	Bans a user for seconds. Let a user out and prevent to join again. If the user is already banned, duration will be updated from the time that was initialized. More...
void	UnbanUser (string inUserId, SbErrorHandler inCompletionHandler)
	Removes ban for a user. More...
void	MuteUser (string inUserId, int inSeconds, string inDescription, SbErrorHandler inCompletionHandler)
	Mutes a user for seconds. Muted user cannot send any messages to the group channel. More...
void	UnmuteUser (string inUserId, SbErrorHandler inCompletionHandler)
	Unmutes a user. More...
void	GetMyMutedInfo (SbMuteInfoHandler inCompletionHandler)
	Gets my muted information in this channel. More...
void	AddOperators (List< string > inUserIds, SbErrorHandler inCompletionHandler)
	Add operators to the channel. More...
void	RemoveOperators (List< string > inUserIds, SbErrorHandler inCompletionHandler)
	Remove operators from the channel. More...
void	RemoveAllOperators (SbErrorHandler inCompletionHandler)
	Remove all operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators. More...
void	AddReaction (SbBaseMessage inMessage, string inKey, SbReactionEventHandler inCompletionHandler)
	Adds a reaction to a message. More...
void	DeleteReaction (SbBaseMessage inMessage, string inKey, SbReactionEventHandler inCompletionHandler)
	Deletes a reaction from a message. More...
void	CreateMessageMetaArrayKeys (SbBaseMessage inMessage, List< string > inKeys, SbBaseMessageHandler inCompletionHandler)
	Creates keys of meta array for the message. More...
void	DeleteMessageMetaArrayKeys (SbBaseMessage inMessage, List< string > inKeys, SbBaseMessageHandler inCompletionHandler)
	Deletes keys from meta array of the message. More...
void	AddMessageMetaArrayValues (SbBaseMessage inMessage, List< SbMessageMetaArray > inMetaArrays, SbBaseMessageHandler inCompletionHandler)
	Adds meta array to the message. More...
void	RemoveMessageMetaArrayValues (SbBaseMessage inMessage, List< SbMessageMetaArray > inMetaArrays, SbBaseMessageHandler inCompletionHandler)
	Removes meta array from the message. More...
void	ReportUser (SbUser inOffendingUser, SbReportCategory inReportCategory, string inReportDescription, SbErrorHandler inCompletionHandler)
	Reports a user in a channel of inappropriate activities. More...
void	ReportMessage (SbBaseMessage inMessage, SbReportCategory inReportCategory, string inReportDescription, SbErrorHandler inCompletionHandler)
	Reports a malicious message in the channel More...
void	Report (SbReportCategory inReportCategory, string inReportDescription, SbErrorHandler inCompletionHandler)
	Reports current channel instance of inappropriate activities. More...

Properties
string	Url [get]
	The unique channel URL. More...
abstract SbChannelType	ChannelType [get]
IReadOnlyDictionary< string, string >	CachedMetaData [get]
	All locally cached metadata as a map. Cached metadata is updated under following circumstances: More...
string	CoverUrl [get]
	The cover image URL. More...
long	CreatedAt [get]
	The creation time of the channel. More...
string	Data [get]
	The channel data. More...
bool	IsEphemeral [get]
	Whether the channel is ephemeral. More...
bool	IsFrozen [get, set]
	Whether the channel is frozen. More...
string	Name [get]
	The topic or name of the channel. More...
string	CustomType [get]
	The custom type of the channel. More...
bool	IsGroupChannel [get]
	Whether the instance is SbGroupChannel type. More...
bool	IsOpenChannel [get]
	Whether the instance is SbOpenChannel type. More...

Detailed Description

Objects representing a channel.

Since

4.0.0

Member Function Documentation

AddMessageMetaArrayValues()

void AddMessageMetaArrayValues	(	SbBaseMessage	inMessage,
		List< SbMessageMetaArray >	inMetaArrays,
		SbBaseMessageHandler	inCompletionHandler
	)

Adds meta array to the message.

Parameters

inMessage
inMetaArrays
inCompletionHandler

Since

4.0.0

AddOperators()

void AddOperators	(	List< string >	inUserIds,
		SbErrorHandler	inCompletionHandler
	)

Add operators to the channel.

Parameters

inUserIds
inCompletionHandler

Since

4.0.0

AddReaction()

void AddReaction	(	SbBaseMessage	inMessage,
		string	inKey,
		SbReactionEventHandler	inCompletionHandler
	)

Adds a reaction to a message.

Parameters

inMessage	The message object that the reaction will be added.
inKey	The reaction key to be added.
inCompletionHandler	The handler block to be executed. If succeeded, the SbReactionEvent will have the information of the reaction.

Since

4.0.0

BanUser()

void BanUser	(	string	inUserId,
		int	inSeconds,
		string	inDescription,
		SbErrorHandler	inCompletionHandler
	)

Bans a user for seconds. Let a user out and prevent to join again. If the user is already banned, duration will be updated from the time that was initialized.

Parameters

inUserId	The user ID to be banned.
inSeconds	Seconds of duration to be banned. Seconds should be larger than -1. If it is -1, user is banned forever. If it is 0, duration is set 10 years by default.
inDescription	The reason why the user was banned.
inCompletionHandler	The handler block to be executed after the user is banned. This block has no return value and takes an argument that is an error made when there is something wrong to ban.

Since

4.0.0

CancelUploadingFileMessage()

bool CancelUploadingFileMessage

(

string

inRequestId

)

Cancels an ongoing FileMessage upload.

Parameters

inRequestId

Returns

Since

4.0.0

CopyFileMessage()

SbFileMessage CopyFileMessage	(	SbFileMessage	inFileMessage,
		SbBaseChannel	inToTargetChannel,
		SbFileMessageHandler	inCompletionHandler
	)

Copies a file message to the target channel.

Parameters

inFileMessage	File message object.
inToTargetChannel	Target channel object.
inCompletionHandler	The handler block to execute. The fileMessage is a user message which is returned from the Sendbird server. The message has a message ID.

Returns

Since

4.0.0

CopyUserMessage()

SbUserMessage CopyUserMessage	(	SbUserMessage	inUserMessage,
		SbBaseChannel	inToTargetChannel,
		SbUserMessageHandler	inCompletionHandler
	)

Copies a user message to the target channel.

Parameters

inUserMessage
inToTargetChannel
inCompletionHandler

Returns

Returns the temporary user message with a request ID. It doesn’t have a message ID. If there is any error, nil could be returned.

Since

4.0.0

CreateBannedUserListQuery()

SbBannedUserListQuery CreateBannedUserListQuery

(

SbBannedUserListQueryParams

inParams

)

Creates a query instance for banned user list of the channel.

Parameters

inParams

SbBannedUserListQueryParams instance.

Returns

The instance for the banned user list. Query only banned user list.

Since

4.0.0

CreateMessageMetaArrayKeys()

void CreateMessageMetaArrayKeys	(	SbBaseMessage	inMessage,
		List< string >	inKeys,
		SbBaseMessageHandler	inCompletionHandler
	)

Creates keys of meta array for the message.

Parameters

inMessage
inKeys
inCompletionHandler

Since

4.0.0

CreateMetaCounters()

void CreateMetaCounters	(	Dictionary< string, int >	inMetaCounters,
		SbMetaCountersHandler	inCompletionHandler
	)

Creates the meta counters for the channel.

Parameters

inMetaCounters
inCompletionHandler

Since

4.0.0

CreateMetaData()

void CreateMetaData	(	Dictionary< string, string >	inMetaData,
		SbMetaDataHandler	inCompletionHandler
	)

Creates meta data. This can be used to customize the channel.

Parameters

inMetaData
inCompletionHandler

Since

4.0.0

CreateMutedUserListQuery()

SbMutedUserListQuery CreateMutedUserListQuery

(

SbMutedUserListQueryParams

inParams

)

Creates a query instance for getting muted user list of the channel instance.

Parameters

inParams

SbMutedUserListQueryParams instance.

Returns

UserListQuery instance for the muted user list.

Since

4.0.0

CreateOperatorListQuery()

SbOperatorListQuery CreateOperatorListQuery

(

SbOperatorListQueryParams

inParams = null

)

Creates a query instance to get the operator list from this channel.

Parameters

inParams

Returns

Since

4.0.0

CreatePreviousMessageListQuery()

SbPreviousMessageListQuery CreatePreviousMessageListQuery

(

SbPreviousMessageListQueryParams

inParams = null

)

Creates previous message list query for this channel.

Parameters

inParams

Returns

Since

4.0.0

DecreaseMetaCounters()

void DecreaseMetaCounters	(	Dictionary< string, int >	inMetaCounters,
		SbMetaCountersHandler	inCompletionHandler
	)

Decreases the meta counters for the channel.

Parameters

inMetaCounters
inCompletionHandler

Since

4.0.0

DeleteAllMetaCounters()

void DeleteAllMetaCounters

(

SbErrorHandler

inCompletionHandler

)

Deletes all meta counters for the channel.

Parameters

inCompletionHandler

Since

4.0.0

DeleteAllMetaData()

void DeleteAllMetaData

(

SbErrorHandler

inCompletionHandler

)

Deletes all meta data for the channel.

Parameters

inCompletionHandler

Since

4.0.0

DeleteMessage()

void DeleteMessage	(	long	inMessageId,
		SbErrorHandler	inCompletionHandler
	)

Deletes a message with message ID.

Parameters

inMessageId
inCompletionHandler

Since

4.0.0

DeleteMessageMetaArrayKeys()

void DeleteMessageMetaArrayKeys	(	SbBaseMessage	inMessage,
		List< string >	inKeys,
		SbBaseMessageHandler	inCompletionHandler
	)

Deletes keys from meta array of the message.

Parameters

inMessage
inKeys
inCompletionHandler

Since

4.0.0

DeleteMetaCounters()

void DeleteMetaCounters	(	string	inKey,
		SbErrorHandler	inCompletionHandler
	)

Deletes the meta counters with key for the channel.

Parameters

inKey
inCompletionHandler

Since

4.0.0

DeleteMetaData()

void DeleteMetaData	(	string	inKey,
		SbErrorHandler	inCompletionHandler
	)

Deletes meta data with key for the channel.

Parameters

inKey
inCompletionHandler

Since

4.0.0

DeleteReaction()

void DeleteReaction	(	SbBaseMessage	inMessage,
		string	inKey,
		SbReactionEventHandler	inCompletionHandler
	)

Deletes a reaction from a message.

Parameters

inMessage	The message object that has the reaction key.
inKey	The reaction key to be deleted.
inCompletionHandler	The handler block to be executed. If succeeded, the SbReactionEvent will have the information of the reaction.

Since

4.0.0

GetAllMetaCounters()

void GetAllMetaCounters

(

SbMetaCountersHandler

inCompletionHandler

)

Parameters

inCompletionHandler

Since

4.0.0

GetAllMetaData()

void GetAllMetaData

(

SbMetaDataHandler

inCompletionHandler

)

Gets all meta data for the channel.

Parameters

inCompletionHandler

Since

4.0.0

GetMessageChangeLogsSinceTimestamp()

void GetMessageChangeLogsSinceTimestamp	(	long	inTimestamp,
		SbMessageChangeLogsParams	inParams,
		SbMessageChangeLogHandler	inCompletionHandler
	)

Requests message change logs after given timestamp. The result is passed to handler.

Parameters

inTimestamp
inParams
inCompletionHandler

Since

4.0.0

GetMessageChangeLogsSinceToken()

void GetMessageChangeLogsSinceToken	(	string	inToken,
		SbMessageChangeLogsParams	inParams,
		SbMessageChangeLogHandler	inCompletionHandler
	)

Requests message change logs after given token. The result is passed to handler.

Parameters

inToken
inParams
inCompletionHandler

Since

4.0.0

GetMessagesByMessageId()

void GetMessagesByMessageId	(	long	inMessageId,
		SbMessageListParams	inParams,
		SbMessageListHandler	inCompletionHandler
	)

Retrieves previous or next messages based on the message ID in a specific channel. The result is passed to handler as list.

Parameters

inMessageId
inParams
inCompletionHandler

Since

4.0.0

GetMessagesByTimestamp()

void GetMessagesByTimestamp	(	long	inTimestamp,
		SbMessageListParams	inParams,
		SbMessageListHandler	inCompletionHandler
	)

Retrieves previous or next messages based on the timestamp in a specific channel. The result is passed to handler as list.

Parameters

inTimestamp
inParams
inCompletionHandler

Since

4.0.0

GetMetaCounters()

void GetMetaCounters	(	List< string >	inKeys,
		SbMetaCountersHandler	inCompletionHandler
	)

Gets the meta counters with keys for the channel.

Parameters

inKeys
inCompletionHandler

Since

4.0.0

GetMetaData()

void GetMetaData	(	List< string >	inKeys,
		SbMetaDataHandler	inCompletionHandler
	)

Gets the meta data for the channel.

Parameters

inKeys
inCompletionHandler

Since

4.0.0

GetMyMutedInfo()

void GetMyMutedInfo

(

SbMuteInfoHandler

inCompletionHandler

)

Gets my muted information in this channel.

Parameters

inCompletionHandler

Since

4.0.0

IncreaseMetaCounters()

void IncreaseMetaCounters	(	Dictionary< string, int >	inMetaCounters,
		SbMetaCountersHandler	inCompletionHandler
	)

Increases the meta counters for the channel.

Parameters

inMetaCounters
inCompletionHandler

Since

4.0.0

MuteUser()

void MuteUser	(	string	inUserId,
		int	inSeconds,
		string	inDescription,
		SbErrorHandler	inCompletionHandler
	)

Mutes a user for seconds. Muted user cannot send any messages to the group channel.

Parameters

inUserId	The user to be muted.
inSeconds	The user cannot send any messages for this time.
inDescription	The description that explains the reason why the user is muted.
inCompletionHandler	The handler block to be executed after mute. This block has no return value and takes an argument that is an error made when there is something wrong to mute the user.

Since

4.0.0

RemoveAllOperators()

void RemoveAllOperators

(

SbErrorHandler

inCompletionHandler

)

Remove all operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators.

Parameters

inCompletionHandler

Since

4.0.0

RemoveMessageMetaArrayValues()

void RemoveMessageMetaArrayValues	(	SbBaseMessage	inMessage,
		List< SbMessageMetaArray >	inMetaArrays,
		SbBaseMessageHandler	inCompletionHandler
	)

Removes meta array from the message.

Parameters

inMessage
inMetaArrays
inCompletionHandler

Since

4.0.0

RemoveOperators()

void RemoveOperators	(	List< string >	inUserIds,
		SbErrorHandler	inCompletionHandler
	)

Remove operators from the channel.

Parameters

inUserIds
inCompletionHandler

Since

4.0.0

Report()

void Report	(	SbReportCategory	inReportCategory,
		string	inReportDescription,
		SbErrorHandler	inCompletionHandler
	)

Reports current channel instance of inappropriate activities.

Parameters

inReportCategory
inReportDescription
inCompletionHandler

Since

4.0.0

ReportMessage()

void ReportMessage	(	SbBaseMessage	inMessage,
		SbReportCategory	inReportCategory,
		string	inReportDescription,
		SbErrorHandler	inCompletionHandler
	)

Reports a malicious message in the channel

Parameters

inMessage
inReportCategory
inReportDescription
inCompletionHandler

Since

4.0.0

ReportUser()

void ReportUser	(	SbUser	inOffendingUser,
		SbReportCategory	inReportCategory,
		string	inReportDescription,
		SbErrorHandler	inCompletionHandler
	)

Reports a user in a channel of inappropriate activities.

Parameters

inOffendingUser
inReportCategory
inReportDescription
inCompletionHandler

Since

4.0.0

ResendFileMessage()

SbFileMessage ResendFileMessage	(	SbFileMessage	inFileMessage,
		SbFileInfo	inFileInfo,
		SbMultiProgressHandler	inProgressHandler,
		SbFileMessageHandler	inCompletionHandler
	)

Attempts to resend a failed file message received by the failure callback.

Parameters

inFileMessage	A message to send. A failed message is passed to the callback when fails to send a message
inFileInfo
inProgressHandler	The handler block to be used to monitor progression. inRequestId is a unique identifier for the message send request. inBytesSent is the number of bytes sent since this method was called. inTotalBytesSent is the total number of bytes sent so far. inTotalBytesExpectedToSend is the expected length of the body data. These parameters are the same to the declaration of
inCompletionHandler	The handler block to be executed after the message is sent. This block has no return value and takes two arguments. One is a file message. If the message is successfully sent, the complete message instance is delivered. If the message fails to be sent, a failed message based on the pending message is delivered except invalid parameter error. If failed because of invalid parameter, message is nil. Another factor is errors. If the message fails to be sent, a message error is dispatched.

Returns

Returns a temporary file message being sent to the Sendbird server.

Since

4.0.0

ResendUserMessage()

SbUserMessage ResendUserMessage	(	SbUserMessage	inUserMessage,
		SbUserMessageHandler	inCompletionHandler
	)

Attempts to resend a failed user message received by the failure callback. Only failed message MUST be passed, not a succeeded message or a pending message.

Parameters

inUserMessage
inCompletionHandler

Returns

Returns a temporary user message being sent to the Sendbird server.

Since

4.0.0

SendFileMessage()

SbFileMessage SendFileMessage	(	SbFileMessageCreateParams	inFileMessageCreateParams,
		SbMultiProgressHandler	inProgressHandler,
		SbFileMessageHandler	inCompletionHandler
	)

Sends a file message with file or file URL of params with progress. If the params has a binary file, it will upload data to Sendbird storage. If not, the params has a file url, it will send a message with file url.

Parameters

inFileMessageCreateParams	The instance of SbFileMessageCreateParams that can has parameters related with file.
inProgressHandler	The handler block to be used to monitor progression. inRequestId is a unique identifier for the message send request. inBytesSent is the number of bytes sent since this method was called. inTotalBytesSent is the total number of bytes sent so far. inTotalBytesExpectedToSend is the expected length of the body data. These parameters are the same to the declaration of
inCompletionHandler	The handler block to be executed after every message was sent. This block has no return value and takes an error. If the sending message can’t start at all because of the connection issue, the error isn’t null.

Returns

Returns a temporary file message being sent to the Sendbird server. The message has a request ID instead of a message ID. The request status of the message is pending. If you try to send a message with an invalid parameter, the returned message is a user message with no properties. You can perform a validation of pending message by checking for the existence of the request ID.

Since

4.0.0

SendUserMessage() [1/2]

SbUserMessage SendUserMessage	(	SbUserMessageCreateParams	inUserMessageCreateParams,
		SbUserMessageHandler	inCompletionHandler
	)

Sends a string message of params.

Parameters

inUserMessageCreateParams
inCompletionHandler

Returns

Returns a temporary user message being sent to the Sendbird server. The message has a request ID instead of a message ID. The request status of the message is pending. If you try to send a message with an invalid parameter, the returned message is a user message with no properties. You can perform a validation of pending message by checking for the existence of the request ID.

Since

4.0.0

SendUserMessage() [2/2]

SbUserMessage SendUserMessage	(	string	inMessage,
		SbUserMessageHandler	inCompletionHandler
	)

Sends a user message.

Parameters

inMessage
inCompletionHandler

Returns

Returns a temporary user message being sent to the Sendbird server. The message has a request ID instead of a message ID. The request status of the message is pending. If you try to send a message with an invalid parameter, the returned message is a user message with no properties. You can perform a validation of pending message by checking for the existence of the request ID.

Since

4.0.0

TranslateUserMessage()

void TranslateUserMessage	(	SbUserMessage	inUserMessage,
		List< string >	inTargetLanguages,
		SbUserMessageHandler	inCompletionHandler
	)

Requests to translate the text message into the target languages.

Parameters

inUserMessage
inTargetLanguages
inCompletionHandler

Since

4.0.0

UnbanUser()

void UnbanUser	(	string	inUserId,
		SbErrorHandler	inCompletionHandler
	)

Removes ban for a user.

Parameters

inUserId	The user ID to be removed ban.
inCompletionHandler	The handler block to be executed after remove ban. This block has no return value and takes an argument that is an error made when there is something wrong to remove ban.

Since

4.0.0

UnmuteUser()

void UnmuteUser	(	string	inUserId,
		SbErrorHandler	inCompletionHandler
	)

Unmutes a user.

Parameters

inUserId	The user ID to be turned off mute.
inCompletionHandler	The handler block to be executed after turn off mute. This block has no return value and takes an argument that is an error made when there is something wrong to turn off mute.

Since

4.0.0

UpdateFileMessage()

void UpdateFileMessage	(	long	inMessageId,
		SbFileMessageUpdateParams	inParams,
		SbFileMessageHandler	inCompletionHandler
	)

Updates a file message. The data, custom type from file message params can be updated.

Parameters

inMessageId	The message ID of the message to be updated.
inParams	The file message params that has updating fields.
inCompletionHandler	The handler block to be executed after update.

Since

4.0.0

UpdateMetaCounters()

void UpdateMetaCounters	(	Dictionary< string, int >	inMetaCounters,
		SbMetaCountersHandler	inCompletionHandler
	)

Gets all meta counters for the channel.

Parameters

inMetaCounters
inCompletionHandler

Since

4.0.0

UpdateMetaData()

void UpdateMetaData	(	Dictionary< string, string >	inMetaData,
		SbMetaDataHandler	inCompletionHandler
	)

Updates the meta data for the channel.

Parameters

inMetaData
inCompletionHandler

Since

4.0.0

UpdateUserMessage()

void UpdateUserMessage	(	long	inMessageId,
		SbUserMessageUpdateParams	inParams,
		SbUserMessageHandler	inCompletionHandler
	)

Updates a user message. The text message, data, custom type from user message params can be updated.

Parameters

inMessageId
inParams
inCompletionHandler

Since

4.0.0

Property Documentation

CachedMetaData

IReadOnlyDictionary<string, string> CachedMetaData

get

All locally cached metadata as a map. Cached metadata is updated under following circumstances:

Since

4.0.0

ChannelType

abstract SbChannelType ChannelType

get

Since

4.0.0

CoverUrl

string CoverUrl

get

The cover image URL.

Since

4.0.0

CreatedAt

long CreatedAt

get

The creation time of the channel.

Since

4.0.0

CustomType

string CustomType

get

The custom type of the channel.

Since

4.0.0

Data

string Data

get

The channel data.

Since

4.0.0

IsEphemeral

bool IsEphemeral

get

Whether the channel is ephemeral.

Since

4.0.0

IsFrozen

bool IsFrozen

getset

Whether the channel is frozen.

Since

4.0.0

IsGroupChannel

bool IsGroupChannel

get

Whether the instance is SbGroupChannel type.

Since

4.0.0

IsOpenChannel

bool IsOpenChannel

get

Whether the instance is SbOpenChannel type.

Since

4.0.0

Name

string Name

get

The topic or name of the channel.

Since

4.0.0

Url

string Url

get

The unique channel URL.

Since

4.0.0