BaseChannel
An object represents base class for channel
-
Identifier for the channel conforming to
Identifiable
-
The channel URL.
-
The name of channel.
-
The channel cover image URL.
-
User who creates the channel
Since
3.0.199 -
The timestamp when the channel is created in seconds.
-
The custom data of the channel.
-
The custom type of the channel.
-
The flag for a frozen channel.
Since
3.0.89 -
Represents the channel is ephemeral or not.
Since
3.0.90 -
Gets the current user’s muted information in this channel.
Since
3.0.118 -
Channel type
-
Indicates possibility of outdated information
-
Checks the channel type is open channel or not.
-
Checks the channel type is group channel or not.
-
Checks the channel type is feed channel or not.
Since
4.6.0 -
Timestamp of when the
MessageCollection
for this channel has been created.Since
4.6.0 -
Encodes this object.
-
Default constructor.
-
Description
-
Retrieves the changelogs since a specified token regarding the updated messages or the unique IDs of deleted messages in the channel.
Since
3.0.181 -
Retrieves the changelogs since a specified timestamp, in Unix milliseconds format, regarding the updated messages or the unique IDs of deleted messages in the channel.
Since
3.0.181 -
Retrieves the changelogs since a specified token regarding the updated polls or the unique IDs of deleted polls in the channel.
Since
4.5.0 -
Retrieves the changelogs since a specified timestamp regarding the updated polls or the unique IDs of deleted polls in the channel.
Since
4.5.0 -
Compares this object with given other object.
-
Sends a file message with file or file URL of params without 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.
-
Sends a file message with file or file URL of params without 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.
-
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.
Since
3.0.116
-
Updates a file message. The data, custom type from file message params can be updated.
Since
3.0.110 -
Attempts to resend a failed file message received by the failure callback.
Only failed message MUST be passed, not a succeeded message or a pending message. If the failed message has a file URL, it means the failed message was created after failure of sending a file message command. So the method retries to send a file message command. If the failed message does not have a file URL, it means the failed message was created from failure of uploading a binary data. So the method retries to upload a binary data frist.
Since
3.0.147 -
Attempts to resend a failed file message received by the failure callback.
Only failed message MUST be passed, not a succeeded message or a pending message. If the failed message has a file URL, it means the failed message was created after failure of sending a file message command. So the method retries to send a file message command. If the failed message does not have a file URL, it means the failed message was created from failure of uploading a binary data. So the method retries to upload a binary data frist.
Since
3.0.147 -
Copies a file message to the target channel.
Note
Only accpets messages whosesendingStatus
is.succeeded
. -
Cancels the file message uploading.
-
Retrieves previous or next messages based on a specified timestamp in the channel.
Since
3.0.181 -
Retrieves previous or next messages based on their message ID in a specific channel.
Since
3.0.181 -
Deletes a message. The message’s sender has to be the current user.
-
Deletes a message. The message’s sender has to be the current user.
Since
3.0.179 -
Creates keys of meta array for the message.
Since
3.0.116 -
Deletes keys from meta array of the message.
Since
3.0.116 -
Adds meta array to the message.
Since
3.0.116
Note
use
addMessageMetaArrayValues(message:metaArrays:completionHandler:)
as possible. -
Adds the array of meta array into the message.
Note
ThemetaArrays
are upserted into the message. If a key in the metaArrays is new, the key will be inserted with the value. If a key in the metaArrays is already created, the value of the messageMetaArray will be inserted so strings in the value MUST be new one.Since
3.0.148 -
Removes meta array from the message.
Since
3.0.116Note
useremoveMessageMetaArrayValues(message:metaArrays:completionHandler:)
as possible. -
Removes the array of meta array from the message.
Note
ThemetaArrays
are removed from the message. If a key in the metaArrays has an emtpy array of the value, the key will be removed. If not, the value of the messageMetaArray will be removed from the message.Note
The order of the meta array is guaranteed.Since
3.0.148 -
Creates the meta counters for the channel.
-
Gets the meta counters with keys for the channel.
-
Gets all meta counters for the channel.
-
Updates the meta counters for the channel.
-
Increases the meta counters for the channel.
-
Decreases the meta counters for the channel.
-
Deletes the meta counters with key for the channel.
-
Deletes all meta counters for the channel.
-
Creates the meta data for the channel.
-
Gets the meta data for the channel.
-
Gets all meta data for the channel.
-
Updates the meta data for the channel.
-
Deletes meta data with key for the channel.
-
Deletes all meta data for the channel.
-
Return cached channel meta data.
Since
3.0.216
-
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.
Since
3.0.89 -
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.
Since
3.0.89 -
Removes ban for a user.
Since
3.0.89 -
Removes ban for a user.
Since
3.0.89
-
Mutes a user with additional options. Muted user cannot send any messages to the group channel.
Since
3.0.118 -
Mutes a user with additional options. Muted user cannot send any messages to the group channel.
Since
3.0.118 -
Unmutes a user.
Since
3.0.89 -
Unmutes a user.
Since
3.0.89 -
Adds operators to the channel.
Since
3.0.189 -
Removes operators from the channel.
Since
3.0.189 -
Removes all operators from the channel.
Since
3.0.189 -
Updates a poll with params.
Since
4.5.0 -
Deletes a poll.
Since
4.5.0 -
Closes a poll.
Since
4.5.0 -
Adds an option to a poll.
Since
4.5.0 -
Updates an option to a poll.
Since
4.5.0 -
Removes Poll option
Since
4.5.0 -
Votes poll
Since
4.5.0 -
Creates a query instance for banned user list of the channel.
Since
3.0.89 -
Creates a query instance for banned user list of the channel.
Since
4.0.1 -
Creates a query instance for banned user list of the channel.
Since
3.0.89 -
Creates a query instance for banned user list of the channel.
Since
4.0.0 -
Creates a query instance for banned user list of the channel.
Since
4.0.1 -
Creates a query instance for banned user list of the channel.
Since
4.0.0 -
Creates a query instance for getting muted user list of the channel instance.
-
Creates a query instance for getting muted user list of the channel instance.
-
Creates a query instance for getting muted user list of the channel instance.
-
Creates a query instance for getting muted user list of the channel instance.
Since
4.0.0 -
Creates a query instance for getting muted user list of the channel instance.
Since
4.0.0 -
Creates a query instance for getting muted user list of the channel instance.
Since
4.0.0 -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel. -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel. -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel. -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel.Since
4.0.0 -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel.Since
4.0.0 -
Creates
PreviousMessageListQuery
instance for getting the previous messages list of the channel.Since
4.0.0 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
3.0.94 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
4.0.0 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
4.0.0 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
4.0.0 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
4.0.0 -
Creates
OperatorListQuery
instance for getting operators in the channel.Since
4.0.0 -
Creates
PollListQuery
instance for getting poll list in this channel.Since
4.5.0 -
Creates
PollVoterListQuery
instance for getting user list on given poll optionSince
4.5.0 -
Creates
PollVoterListQuery
instance for getting user list on given poll optionSince
4.5.0 -
Adds a reaction to a message.
Messages with
sendingStatus
is not.success
will handler to return error.Note
This is idempotent.Note
This feature is only available in group channels.Since
3.0.169 -
Deletes a reaction from a message.
Note
This is idempotent.Note
This feature is only available in group channels.Since
3.0.169 -
Reports a user in a channel of inappropriate activities.
Since
3.0.154 -
Reports current channel instance of inappropriate activities.
Since
3.0.154 -
Reports a malicious message in the channel
Since
3.0.154 -
Sends a user message.
-
Sends a string message of params.
-
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.
Since
3.0.141 -
Copies a user message to the target channel.
Note
Only accpets messages whosesendingStatus
is.succeeded
. -
Updates a user message. The text message, data, custom type from user message params can be updated.
Since
3.0.110 -
Requests to translate the text message into the target languages.
You can get a user message with the
translations
property after the request, but the request does not trigger an update event on the message and does not get the message bygetMessageChangeLogs(token:params:completionHandler:)
.A translation request can affect not only your message, but also other people’s messages.
Since
3.0.148 -
Serializes this object into data
-
Deserializes and reconstructs the object
-
Initialize with json dictionary
-
Converts the object into dictionary