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.
The HiddenState of this channel.
My invitation timestamp.
The inviter of the current user to this channel.
Readonly isWhether this channel requires access code to join. This value is valid only if this channel is a public GroupChannel.
Readonly isChecks whether this channel is a broadcast GroupChannel.
Readonly isChecks whether this channel is a chat notification GroupChannel.
Readonly isChecks whether this channel is discoverable in the result of PublicGroupChannelListQuery. If it is false, it will not appear on the result of PublicGroupChannelListQuery.
Readonly isChecks whether this channel is a distinct GroupChannel. For a distinct GroupChannel, later when you create GroupChannel with same User and isDistinct flag being true (refer to createChannel), the channel URL does not change, which means the messages between Users remain at the channel. If the channel is not distinct one, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
Whether the channel is ephemeral.
Readonly isChecks whether this channel is an exclusive GroupChannel.
Whether the channel is frozen.
Readonly isChecks whether this channel is a public GroupChannel.
Readonly isReadonly isChecks whether this channel is a super GroupChannel.
The timestamp when the current user joined.
The total joined member count for this channel.
The last message of the channel.
The last message among channel's pinned messages.
The total member count for this channel.
Member list for this channel.
This property is set when resetMyHistory or hide is called.
Checks whether unread message count is enabled for this channel. This count preference can be set by setMyCountPreference.
Current user's last read receipt timestamp in channel.
My member state.
My muted state in this channel.
My push trigger option. The push trigger setting can be updated by setMyPushTriggerOption.
My Role in this channel.
The pinned message IDs of the channel.
The total unread reply count for this channel.
The unread mention count for this channel for the current user.
The unread message count for this channel for the current user.
All locally cached metadata as a map.
Snapshot of member delivery state map.
Snapshot of member reading state map.
The creation time of the channel in milliseconds.
Checks whether this channel is hidden.
Whether one or more members are typing.
The local timestamp of when this channel has been used in a MessageCollection.
The topic or name of the channel.
The unique channel URL.
Optional accessCode: stringAccepts the invitation sent to the current user. After the acceptance, the user will be joined to the channel.
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.
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 a query instance to get members.
Creates MessageCollection instance with the params.
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 pinned messages.
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.
Creates a file message to be sent at the specified time.
Creates a user message to be sent at the specified time.
Creates a query instance to get threaded parent messages.
Declines the invitation sent to the current user.
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.
Gets delivered time for all members in this channel.
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.
Gets push trigger option of this channel. Refer to PushTriggerOption. For details of push trigger option, refer to setMyPushTriggerOption.
Requests poll change logs after given timestamp.
Requests poll change logs after given token.
Gets the member list who have read the given message.
Gets ReadStatus for all members in this channel.
Returns the number of member's that haven't received the given message. This excludes the current user and the Sender of the message. It will always be zero if the passed on message is an AdminMessage, or if this channel is a super group channel.
Returns the number of member's that haven't read the given message. This excludes the current user and the Sender of the message. It will always be zero if the passed on message is an AdminMessage, or if this channel is a super group channel.
Gets the member list who haven't read the given message.
Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.
Increases meta counters. This increases atomically the keyed meta counter by the specified value.
Invites Users to this channel.
Invites Users with userIds.
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.
Checks if the current user has read the message.
Optional accessCode: stringJoins this channel if this channel is public.
Optional duration: numberOptional description: stringMutes a User with userId. A muted user cannot send a message.
Refreshes all the data of this channel.
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.
Resends a failed message.
Optional file: FileCompatResends a failed message.
since v4.9.8. Use resendMessage() instead.
Resends a failed user message.
Resets the chat history of this channel for the current user. After this call, the messages created before the call will not be loaded.
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.
Serializes a GroupChannel instance. The instance can be restored by buildGroupChannelFromSerializedData.
Sets my count preference for this channel.
Sets push trigger option of this channel. If channel's push trigger option is set to DEFAULT, it works according to the state of PushTriggerOption. If not, push messages will be triggered according to the state of PushTriggerOption.
Translates a user message.
Unbans User with userId.
Unhides this channel from the current User's GroupChannel list.
Unmutes User with userId. The unmuted user could send a message again.
Update this channel with GroupChannelUpdateParams.
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.
Update a scheduled file message with scheduledMessageId and ScheduledFileMessageUpdateParams.
Update a scheduled user message with scheduledMessageId and ScheduledUserMessageUpdateParams.
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
Represents a group channel.