The cover image URL.
A User who created the channel. null if it's created by system.
The custom type of the channel.
The channel data.
Whether the channel is ephemeral.
Whether the channel is frozen.
All locally cached metadata as a map.
The creation time of the channel in milliseconds.
The local timestamp of when this channel has been used in a MessageCollection.
The topic or name of the channel.
The unique channel URL.
Adds message meta array values.
Adds Reaction.
Optional duration: numberOptional description: stringBans a member. Operators can ban members from this channel. Banned member is kicked out of this channel and cannot enter during the specified seconds. If you want to ban the user indefinitely, pass -1 to seconds as the argument.
Cancels an ongoing FileMessage upload.
since v4.9.8. Use copyMessage() instead.
Copies a file message from this channel to the target channel.
Copies a message from this channel to the target channel.
Copies a message from this channel to the target channel.
since v4.9.8. Use copyMessage() instead.
Copies a user message from this channel to the target channel.
Creates a query instance to get the banned user list from this channel.
Creates message meta array keys.
Creates meta counters. This can be used to customize the channel.
Creates a query instance to get the muted user (online and offline both) list of this channel.
Creates a query instance to get the operator list from this channel.
Creates a query instance to get the poll list from this channel.
Creates a query instance to get the voters of a poll option.
Creates previous message list query for this channel.
Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.
Deletes a message.
Deletes message meta array keys.
Deletes Reaction.
Get all meta counters.
Requests message change logs after given timestamp.
Requests message change logs after given token.
Retrieves previous or next messages based on the message ID in a specific channel.
Retrieves previous or next messages based on the timestamp in a specific channel.
Gets meta counters.
Requests poll change logs after given timestamp.
Requests poll change logs after given token.
Increases meta counters. This increases atomically the keyed meta counter by the specified value.
Whether the given channel is equal in all the values of this channel.
Whether the instance is FeedChannel type.
Whether the instance is GroupChannel type.
Whether the given channel is identical to this channel.
Whether the instance is OpenChannel type.
Optional duration: numberOptional description: stringMutes a User with userId. A muted user cannot send a message.
Removes message meta array values.
Reports this channel of inappropriate activities.
[UserMessage], [FileMessage] or [MultipleMessage]
Reports a malicious message.
Reports a user of suspicious activities.
Optional file: FileCompatsince v4.9.8. Use resendMessage() instead.
Resends a file with given file information.
Optional file: FileCompatResends a failed message.
Resends a failed message.
since v4.9.8. Use resendMessage() instead.
Resends a failed user message.
Sends a file with given file information.
Sends files with given files information. The maximum number of files is 20. This method handles FileMessageCreateParams only which have set binary file not URL.
Sends a multiple files or file URLs as a single MultipleFilesMessage.
Sends a user message.
Translates a user message.
Unbans User with userId.
Unmutes User with userId. The unmuted user could send a message again.
Updates a FileMessage that was previously sent in the channel. Note that the file itself cannot be changed; only the fields stored within the message can be modified.
Updates meta counters.
Updates fields of this poll with given params. Once updated successfully, a non-null Poll instance will be passed to the result.
Updates a UserMessage that was previously sent in the channel.
Uploads a file and gets the URL and thumbnails.
It takes progressHandler as a parameter to keep track of upload progress.
Vote on pollOptionIds. This operation overrides previous vote actions, so to update previous vote, pass new pollOptionIds as parameter. To cancel votes, pass an empty list as pollOptionIds.
Generated using TypeDoc
Description
Objects representing a channel.