ClassGroupChannel

Description

Represents a group channel.

Hierarchy (view full)

BaseChannel
- GroupChannel

Index

Accessors

cachedMetaData cachedUndeliveredMemberState cachedUnreadMemberState createdAt hasAiBot hasBot isHidden isTyping messageCollectionLastAccessedAt name url

Methods

acceptInvitation addMessageMetaArrayValues addOperators addPollOption addReaction banUser banUserWithUserId cancelScheduledMessage cancelUploadingFileMessage closePoll copyFileMessage copyMessage copyUserMessage createBannedUserListQuery createMemberListQuery createMessageCollection createMessageMetaArrayKeys createMetaCounters createMetaData createMutedUserListQuery createOperatorListQuery createPinnedMessageListQuery createPollListQuery createPollVoterListQuery createPreviousMessageListQuery createScheduledFileMessage createScheduledUserMessage createThreadedParentMessageListQuery declineInvitation decreaseMetaCounters delete deleteAllMetaCounters deleteAllMetaData deleteMessage deleteMessageMetaArrayKeys deleteMetaCounter deleteMetaData deletePoll deletePollOption deleteReaction endTyping freeze getAllMetaCounters getAllMetaData getDeliveryStatus getMessageChangeLogsSinceTimestamp getMessageChangeLogsSinceToken getMessagesByMessageId getMessagesByTimestamp getMetaCounters getMetaData getMyMutedInfo getMyPushTriggerOption getPollChangeLogsSinceTimestamp getPollChangeLogsSinceToken getReadMembers getReadStatus getTypingUsers getUndeliveredMemberCount getUnreadMemberCount getUnreadMembers hide increaseMetaCounters invite inviteWithUserIds isEqual isFeedChannel isGroupChannel isIdentical isOpenChannel isReadMessage join leave markAsDelivered markAsRead muteUser muteUserWithUserId pinMessage refresh removeMessageMetaArrayValues removeOperators report reportMessage reportUser resendFileMessage resendMessage resendUserMessage resetMyHistory sendFileMessage sendFileMessages sendMultipleFilesMessage sendScheduledMessageNow sendUserMessage serialize setMyCountPreference setMyPushTriggerOption startTyping translateUserMessage unbanUser unbanUserWithUserId unfreeze unhide unmuteUser unmuteUserWithUserId unpinMessage updateChannel updateFileMessage updateMetaCounters updateMetaData updatePoll updatePollOption updateScheduledFileMessage updateScheduledUserMessage updateUserMessage uploadFile votePoll

Properties

channelType

channelType: ChannelType = ChannelType.BASE

coverUrl

coverUrl: string = ''

The cover image URL.

creator

creator: null | User = null

A User who created the channel. null if it's created by system.

customType

customType: string = ''

The custom type of the channel.

data

data: string = ''

The channel data.

hiddenState

hiddenState: HiddenState = HiddenState.UNHIDDEN

The HiddenState of this channel.

invitedAt

invitedAt: number = 0

My invitation timestamp.

inviter

inviter: null | User = null

The inviter of the current user to this channel.

`Readonly`isAccessCodeRequired

isAccessCodeRequired: boolean = false

Whether this channel requires access code to join. This value is valid only if this channel is a public GroupChannel.

`Readonly`isBroadcast

isBroadcast: boolean = false

Checks whether this channel is a broadcast GroupChannel.

`Readonly`isChatNotification

isChatNotification: boolean = false

Checks whether this channel is a chat notification GroupChannel.

`Readonly`isDiscoverable

isDiscoverable: boolean = true

Checks whether this channel is discoverable in the result of PublicGroupChannelListQuery. If it is false, it will not appear on the result of PublicGroupChannelListQuery.

`Readonly`isDistinct

isDistinct: boolean = false

Checks 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 GroupChannelModule.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.

isEphemeral

isEphemeral: boolean = false

Whether the channel is ephemeral.

`Readonly`isExclusive

isExclusive: boolean = false

Checks whether this channel is an exclusive GroupChannel.

isFrozen

isFrozen: boolean = false

Whether the channel is frozen.

`Readonly`isPublic

isPublic: boolean = false

Checks whether this channel is a public GroupChannel.

`Readonly`isPushEnabled

isPushEnabled: boolean = false

Deprecated

`Readonly`isSuper

isSuper: boolean = false

Checks whether this channel is a super GroupChannel.

joinedAt

joinedAt: number = 0

The timestamp when the current user joined.

joinedMemberCount

joinedMemberCount: number = 0

The total joined member count for this channel.

lastMessage

lastMessage: null | BaseMessage = null

The last message of the channel.

lastPinnedMessage

lastPinnedMessage: null | BaseMessage = null

The last message among channel's pinned messages.

memberCount

memberCount: number = 0

The total member count for this channel.

members

members: Member[] = []

Member list for this channel.

messageOffsetTimestamp

messageOffsetTimestamp: number = 0

This property is set when GroupChannel.resetMyHistory or GroupChannel.hide is called.

myCountPreference

myCountPreference: CountPreference = CountPreference.ALL

Checks whether unread message count is enabled for this channel. This count preference can be set by GroupChannel.setMyCountPreference.

myLastRead

myLastRead: number = 0

Current user's last read receipt timestamp in channel.

myMemberState

myMemberState: MemberState = MemberState.NONE

My member state.

myMutedState

myMutedState: MutedState = MutedState.UNMUTED

My muted state in this channel.

myPushTriggerOption

myPushTriggerOption: PushTriggerOption = PushTriggerOption.DEFAULT

My push trigger option. The push trigger setting can be updated by GroupChannel.setMyPushTriggerOption.

myRole

myRole: Role = Role.NONE

My Role in this channel.

pinnedMessageIds

pinnedMessageIds: number[] = []

The pinned message IDs of the channel.

totalUnreadReplyCount

totalUnreadReplyCount: number = 0

The total unread reply count for this channel.

unreadMentionCount

unreadMentionCount: number = 0

The unread mention count for this channel for the current user.

unreadMessageCount

unreadMessageCount: number = 0

The unread message count for this channel for the current user.

Accessors

cachedMetaData

get cachedMetaData(): object
All locally cached metadata as a map.

Returns object
Inherited from BaseChannel.cachedMetaData

cachedUndeliveredMemberState

get cachedUndeliveredMemberState(): object
Snapshot of member delivery state map.

Returns object

cachedUnreadMemberState

get cachedUnreadMemberState(): object
Snapshot of member reading state map.

Returns object

createdAt

get createdAt(): number
The creation time of the channel in milliseconds.

Returns number
Inherited from BaseChannel.createdAt

hasAiBot

get hasAiBot(): boolean
Indicates whether this channel includes any AI bots.

Returns boolean

hasBot

get hasBot(): boolean
Indicates whether this channel includes any bots

Returns boolean

isHidden

get isHidden(): boolean
Checks whether this channel is hidden.

Returns boolean

isTyping

get isTyping(): boolean
Whether one or more members are typing.

Returns boolean

messageCollectionLastAccessedAt

get messageCollectionLastAccessedAt(): number
The local timestamp of when this channel has been used in a MessageCollection.

Returns number
Inherited from BaseChannel.messageCollectionLastAccessedAt

name

get name(): string
The topic or name of the channel.

Returns string
Inherited from BaseChannel.name
set name(value): void
Parameters
- value: string
Returns void
Inherited from BaseChannel.name

url

get url(): string
The unique channel URL.

Returns string
Inherited from BaseChannel.url

Methods

acceptInvitation

acceptInvitation(accessCode?): Promise<GroupChannel>
Parameters
- OptionalaccessCode: string
Returns Promise<GroupChannel>
Description
Accepts the invitation sent to the current user. After the acceptance, the user will be joined to the channel.

addMessageMetaArrayValues

addMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>
Description
Adds message meta array values.

Inherited from BaseChannel.addMessageMetaArrayValues

addOperators

addOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>
Description
Add operators to the channel.

Inherited from BaseChannel.addOperators

addPollOption

addPollOption(pollId, optionText): Promise<Poll>
Parameters
- pollId: number
- optionText: string
Returns Promise<Poll>
Description
Adds an option with optionText to this poll. Once added successfully, a non-null Poll instance will be passed to the result.

Inherited from BaseChannel.addPollOption

addReaction

addReaction(message, key): Promise<ReactionEvent>
Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>
Description
Adds Reaction.

Inherited from BaseChannel.addReaction

banUser

banUser(user, duration?, description?): Promise<void>
Parameters
- user: User
- Optionalduration: number
- Optionaldescription: string
Returns Promise<void>
Description
Bans 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.

Inherited from BaseChannel.banUser

banUserWithUserId

banUserWithUserId(userId, duration?, description?): Promise<void>
Parameters
- userId: string
- Optionalduration: number
- Optionaldescription: string
Returns Promise<void>
Description
Bans a member with userId.

Inherited from BaseChannel.banUserWithUserId

cancelScheduledMessage

cancelScheduledMessage(scheduledMessageId): Promise<void>
Parameters
- scheduledMessageId: number
Returns Promise<void>
Description
Cancels a scheduled message with scheduledMessageId.

cancelUploadingFileMessage

cancelUploadingFileMessage(requestId): Promise<boolean>
Parameters
- requestId: string
Returns Promise<boolean>
Description
Cancels an ongoing FileMessage upload.

Inherited from BaseChannel.cancelUploadingFileMessage

closePoll

closePoll(pollId): Promise<Poll>
Parameters
- pollId: number
Returns Promise<Poll>
Description
Closes this poll. Once closed successfully, a non-null Poll instance will be passed to the result.

Inherited from BaseChannel.closePoll

copyFileMessage

copyFileMessage(targetChannel, message): Promise<FileMessage>
Parameters
- targetChannel: BaseChannel
- message: FileMessage
Returns Promise<FileMessage>
Deprecated
since v4.9.8. Use copyMessage() instead.

Description
Copies a file message from this channel to the target channel.

Inherited from BaseChannel.copyFileMessage

copyMessage

copyMessage(channel, message): MessageRequestHandler<FileMessage>
Parameters
- channel: BaseChannel
- message: FileMessage
Returns MessageRequestHandler<FileMessage>
Description
Copies a message from this channel to the target channel.

Overrides BaseChannel.copyMessage
copyMessage(channel, message): MessageRequestHandler<UserMessage>
Parameters
- channel: BaseChannel
- message: UserMessage
Returns MessageRequestHandler<UserMessage>
Description
Copies a message from this channel to the target channel.

Overrides BaseChannel.copyMessage
copyMessage(channel, message): MessageRequestHandler<MultipleFilesMessage>
Parameters
- channel: BaseChannel
- message: MultipleFilesMessage
Returns MessageRequestHandler<MultipleFilesMessage>
Description
Copies a message from this channel to the target channel.

Overrides BaseChannel.copyMessage

copyUserMessage

copyUserMessage(targetChannel, message): Promise<UserMessage>
Parameters
- targetChannel: BaseChannel
- message: UserMessage
Returns Promise<UserMessage>
Deprecated
since v4.9.8. Use copyMessage() instead.

Description
Copies a user message from this channel to the target channel.

Inherited from BaseChannel.copyUserMessage

createBannedUserListQuery

createBannedUserListQuery(params?): BannedUserListQuery
Parameters
- params: BannedUserListQueryParams = {}
Returns BannedUserListQuery
Description
Creates a query instance to get the banned user list from this channel.

Inherited from BaseChannel.createBannedUserListQuery

createMemberListQuery

createMemberListQuery(params?): MemberListQuery
Parameters
- params: MemberListQueryParams = {}
Returns MemberListQuery
Description
Creates a query instance to get members.

createMessageCollection

createMessageCollection(params?): MessageCollection
Parameters
- params: MessageCollectionParams = {}
Returns MessageCollection
Description
Creates MessageCollection instance with the params.

createMessageMetaArrayKeys

createMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>
Description
Creates message meta array keys.

Inherited from BaseChannel.createMessageMetaArrayKeys

createMetaCounters

createMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>
Description
Creates meta counters. This can be used to customize the channel.

Inherited from BaseChannel.createMetaCounters

createMetaData

createMetaData(data): Promise<MetaData>
Parameters
- data: MetaData
Returns Promise<MetaData>
Description
Creates meta data. This can be used to customize the channel.

Inherited from BaseChannel.createMetaData

createMutedUserListQuery

createMutedUserListQuery(params?): MutedUserListQuery
Parameters
- params: MutedUserListQueryParams = {}
Returns MutedUserListQuery
Description
Creates a query instance to get the muted user (online and offline both) list of this channel.

Inherited from BaseChannel.createMutedUserListQuery

createOperatorListQuery

createOperatorListQuery(params?): OperatorListQuery
Parameters
- params: OperatorListQueryParams = {}
Returns OperatorListQuery
Description
Creates a query instance to get the operator list from this channel.

Inherited from BaseChannel.createOperatorListQuery

createPinnedMessageListQuery

createPinnedMessageListQuery(params?): PinnedMessageListQuery
Parameters
- params: PinnedMessageListQueryParams = {}
Returns PinnedMessageListQuery
Description
Creates a query instance to get pinned messages.

Inherited from BaseChannel.createPinnedMessageListQuery

createPollListQuery

createPollListQuery(limit?): PollListQuery
Parameters
- limit: number = DEFAULT_POLLS_LIMIT
Returns PollListQuery
Description
Creates a query instance to get the poll list from this channel.

Inherited from BaseChannel.createPollListQuery

createPollVoterListQuery

createPollVoterListQuery(pollId, pollOptionId, limit?): PollVoterListQuery
Parameters
- pollId: number
- pollOptionId: number
- limit: number = DEFAULT_POLL_VOTER_LIST_LIMIT
Returns PollVoterListQuery
Description
Creates a query instance to get the voters of a poll option.

Inherited from BaseChannel.createPollVoterListQuery

createPreviousMessageListQuery

createPreviousMessageListQuery(params?): PreviousMessageListQuery
Parameters
- params: PreviousMessageListQueryParams = {}
Returns PreviousMessageListQuery
Description
Creates previous message list query for this channel.

Inherited from BaseChannel.createPreviousMessageListQuery

createScheduledFileMessage

createScheduledFileMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: ScheduledFileMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Creates a file message to be sent at the specified time.

createScheduledUserMessage

createScheduledUserMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: ScheduledUserMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Creates a user message to be sent at the specified time.

createThreadedParentMessageListQuery

createThreadedParentMessageListQuery(params?): ThreadedParentMessageListQuery
Parameters
- params: ThreadedParentMessageListQueryParams = {}
Returns ThreadedParentMessageListQuery
Description
Creates a query instance to get threaded parent messages.

declineInvitation

declineInvitation(): Promise<GroupChannel>
Returns Promise<GroupChannel>
Description
Declines the invitation sent to the current user.

decreaseMetaCounters

decreaseMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>
Description
Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.

Inherited from BaseChannel.decreaseMetaCounters

delete

delete(): Promise<void>
Returns Promise<void>
Description
Deletes this GroupChannel. Note that only operators of a channel are able to delete it. Otherwise, an error will be thrown.

deleteAllMetaCounters

deleteAllMetaCounters(): Promise<void>
Returns Promise<void>
Description
Deletes all meta counters.

Inherited from BaseChannel.deleteAllMetaCounters

deleteAllMetaData

deleteAllMetaData(): Promise<void>
Returns Promise<void>
Description
Deletes all meta data.

Inherited from BaseChannel.deleteAllMetaData

deleteMessage

deleteMessage(message): Promise<void>
Parameters
- message: BaseMessage
Returns Promise<void>
Description
Deletes a message.

Overrides BaseChannel.deleteMessage

deleteMessageMetaArrayKeys

deleteMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>
Description
Deletes message meta array keys.

Inherited from BaseChannel.deleteMessageMetaArrayKeys

deleteMetaCounter

deleteMetaCounter(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Description
Deletes a meta counter.

Inherited from BaseChannel.deleteMetaCounter

deleteMetaData

deleteMetaData(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Description
Deletes a meta data.

Inherited from BaseChannel.deleteMetaData

deletePoll

deletePoll(pollId): Promise<void>
Parameters
- pollId: number
Returns Promise<void>
Description
Deletes this poll. Once deleted successfully, null will be passed to the result.

Inherited from BaseChannel.deletePoll

deletePollOption

deletePollOption(pollId, pollOptionId): Promise<void>
Parameters
- pollId: number
- pollOptionId: number
Returns Promise<void>
Description
Deletes this poll option.

Inherited from BaseChannel.deletePollOption

deleteReaction

deleteReaction(message, key): Promise<ReactionEvent>
Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>
Description
Deletes Reaction.

Inherited from BaseChannel.deleteReaction

endTyping

endTyping(): Promise<void>
Returns Promise<void>
Description
Sends end typing event.

freeze

freeze(): Promise<void>
Returns Promise<void>
Description
Freezes the channel. No one could send a message in a frozen channel.

Overrides BaseChannel.freeze

getAllMetaCounters

getAllMetaCounters(): Promise<MetaCounter>
Returns Promise<MetaCounter>
Description
Get all meta counters.

Inherited from BaseChannel.getAllMetaCounters

getAllMetaData

getAllMetaData(): Promise<MetaData>
Returns Promise<MetaData>
Description
Gets all meta data.

Inherited from BaseChannel.getAllMetaData

getDeliveryStatus

getDeliveryStatus(includeAllMembers?): null | {
[key: string]: DeliveryStatus;
}
Parameters
- includeAllMembers: boolean = true
Returns null | {
[key: string]: DeliveryStatus;
}
Description
Gets delivered time for all members in this channel.

getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceTimestamp(ts, params?): Promise<MessageChangelogs>
Parameters
- ts: number
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>
Description
Requests message change logs after given timestamp.

Inherited from BaseChannel.getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceToken

getMessageChangeLogsSinceToken(token, params?): Promise<MessageChangelogs>
Parameters
- token: string
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>
Description
Requests message change logs after given token.

Inherited from BaseChannel.getMessageChangeLogsSinceToken

getMessagesByMessageId

getMessagesByMessageId(messageId, params): Promise<BaseMessage[]>
Parameters
- messageId: number
- params: MessageListParams
Returns Promise<BaseMessage[]>
Description
Retrieves previous or next messages based on the message ID in a specific channel.

Inherited from BaseChannel.getMessagesByMessageId

getMessagesByTimestamp

getMessagesByTimestamp(ts, params): Promise<BaseMessage[]>
Parameters
- ts: number
- params: MessageListParams
Returns Promise<BaseMessage[]>
Description
Retrieves previous or next messages based on the timestamp in a specific channel.

Inherited from BaseChannel.getMessagesByTimestamp

getMetaCounters

getMetaCounters(keys): Promise<MetaCounter>
Parameters
- keys: string[]
Returns Promise<MetaCounter>
Description
Gets meta counters.

Inherited from BaseChannel.getMetaCounters

getMetaData

getMetaData(keys): Promise<MetaData>
Parameters
- keys: string[]
Returns Promise<MetaData>
Description
Gets meta data.

Inherited from BaseChannel.getMetaData

getMyMutedInfo

getMyMutedInfo(): Promise<MutedInfo>
Returns Promise<MutedInfo>
Description
Gets my muted information in this channel.

Inherited from BaseChannel.getMyMutedInfo

getMyPushTriggerOption

getMyPushTriggerOption(): Promise<PushTriggerOption>
Returns Promise<PushTriggerOption>
Description
Gets push trigger option of this channel. Refer to PushTriggerOption. For details of push trigger option, refer to GroupChannel.setMyPushTriggerOption.

getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceTimestamp(ts): Promise<PollChangelogs>
Parameters
- ts: number
Returns Promise<PollChangelogs>
Description
Requests poll change logs after given timestamp.

Inherited from BaseChannel.getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceToken

getPollChangeLogsSinceToken(token): Promise<PollChangelogs>
Parameters
- token: null | string
Returns Promise<PollChangelogs>
Description
Requests poll change logs after given token.

Inherited from BaseChannel.getPollChangeLogsSinceToken

getReadMembers

getReadMembers(message, includeAllMembers?): Member[]
Parameters
- message: BaseMessage
- includeAllMembers: boolean = false
Returns Member[]
Description
Gets the member list who have read the given message.

getReadStatus

getReadStatus(includeAllMembers?): null | {
[key: string]: ReadStatus;
}
Parameters
- includeAllMembers: boolean = false
Returns null | {
[key: string]: ReadStatus;
}
Description
Gets ReadStatus for all members in this channel.

getTypingUsers

getTypingUsers(): Member[]
Returns Member[]
Description
The typing user list.

getUndeliveredMemberCount

getUndeliveredMemberCount(message): number
Parameters
- message: BaseMessage
Returns number
Description
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.

getUnreadMemberCount

getUnreadMemberCount(message): number
Parameters
- message: BaseMessage
Returns number
Description
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.

getUnreadMembers

getUnreadMembers(message, includeAllMembers?): Member[]
Parameters
- message: BaseMessage
- includeAllMembers: boolean = false
Returns Member[]
Description
Gets the member list who haven't read the given message.

hide

hide(params): Promise<GroupChannel>
Parameters
- params: GroupChannelHideParams
Returns Promise<GroupChannel>
Description
Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.

increaseMetaCounters

increaseMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>
Description
Increases meta counters. This increases atomically the keyed meta counter by the specified value.

Inherited from BaseChannel.increaseMetaCounters

invite

invite(users): Promise<GroupChannel>
Parameters
- users: User[]
Returns Promise<GroupChannel>
Description
Invites Users to this channel.

inviteWithUserIds

inviteWithUserIds(userIds): Promise<GroupChannel>
Parameters
- userIds: string[]
Returns Promise<GroupChannel>
Description
Invites Users with userIds.

isEqual

isEqual(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean
Description
Whether the given channel is equal in all the values of this channel.

Inherited from BaseChannel.isEqual

isFeedChannel

isFeedChannel(): this is FeedChannel
Returns this is FeedChannel
Description
Whether the instance is FeedChannel type.

Inherited from BaseChannel.isFeedChannel

isGroupChannel

isGroupChannel(): this is GroupChannel
Returns this is GroupChannel
Description
Whether the instance is GroupChannel type.

Inherited from BaseChannel.isGroupChannel

isIdentical

isIdentical(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean
Description
Whether the given channel is identical to this channel.

Inherited from BaseChannel.isIdentical

isOpenChannel

isOpenChannel(): this is OpenChannel
Returns this is OpenChannel
Description
Whether the instance is OpenChannel type.

Inherited from BaseChannel.isOpenChannel

isReadMessage

isReadMessage(message): boolean
Parameters
- message: BaseMessage
Returns boolean
Description
Checks if the current user has read the message.

join

join(accessCode?): Promise<GroupChannel>
Parameters
- OptionalaccessCode: string
Returns Promise<GroupChannel>
Description
Joins this channel if this channel is public.

leave

leave(shouldRemoveOperatorStatus?): Promise<void>
Parameters
- shouldRemoveOperatorStatus: boolean = false
Returns Promise<void>
Description
Leaves this channel.

markAsDelivered

markAsDelivered(): Promise<void>
Returns Promise<void>
Description
Sends mark as delivered to this channel.

markAsRead

markAsRead(): Promise<void>
Returns Promise<void>
Description
Sends mark as read to this channel.

muteUser

muteUser(user, duration?, description?): Promise<void>
Parameters
- user: User
- Optionalduration: number
- Optionaldescription: string
Returns Promise<void>
Description
Mutes a User. A muted user cannot send a message.

Inherited from BaseChannel.muteUser

muteUserWithUserId

muteUserWithUserId(userId, duration?, description?): Promise<void>
Parameters
- userId: string
- Optionalduration: number
- Optionaldescription: string
Returns Promise<void>
Description
Mutes a User with userId. A muted user cannot send a message.

Inherited from BaseChannel.muteUserWithUserId

pinMessage

pinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>
Description
Pins a message to the channel.

Inherited from BaseChannel.pinMessage

refresh

refresh(): Promise<GroupChannel>
Returns Promise<GroupChannel>
Description
Refreshes all the data of this channel.

removeMessageMetaArrayValues

removeMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>
Description
Removes message meta array values.

Inherited from BaseChannel.removeMessageMetaArrayValues

removeOperators

removeOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>
Description
Remove operators from the channel.

Inherited from BaseChannel.removeOperators

report

report(category, description): Promise<void>
Parameters
- category: ReportCategory
- description: string
Returns Promise<void>
Description
Reports this channel of inappropriate activities.

Inherited from BaseChannel.report

reportMessage

reportMessage(message, category, description): Promise<void>
Parameters
- message: UserMessage | FileMessage | MultipleFilesMessage
  [UserMessage], [FileMessage] or [MultipleMessage]
- category: ReportCategory
- description: string
Returns Promise<void>
Description
Reports a malicious message.

Inherited from BaseChannel.reportMessage

reportUser

reportUser(user, category, description): Promise<void>
Parameters
- user: User
- category: ReportCategory
- description: string
Returns Promise<void>
Description
Reports a user of suspicious activities.

Inherited from BaseChannel.reportUser

resendFileMessage

resendFileMessage(failedMessage, file?): Promise<FileMessage>
Parameters
- failedMessage: FileMessage
- Optionalfile: FileCompat
Returns Promise<FileMessage>
Deprecated
since v4.9.8. Use resendMessage() instead.

Description
Resends a file with given file information.

Inherited from BaseChannel.resendFileMessage

resendMessage

resendMessage(failedMessage): MultipleFilesMessageRequestHandler<MultipleFilesMessage>
Parameters
- failedMessage: MultipleFilesMessage
Returns MultipleFilesMessageRequestHandler<MultipleFilesMessage>
Description
Resends a failed message.

Overrides BaseChannel.resendMessage
resendMessage(failedMessage, file?): MessageRequestHandler<FileMessage>
Parameters
- failedMessage: FileMessage
- Optionalfile: FileCompat
Returns MessageRequestHandler<FileMessage>
Description
Resends a failed message.

Overrides BaseChannel.resendMessage
resendMessage(failedMessage): MessageRequestHandler<UserMessage>
Parameters
- failedMessage: UserMessage
Returns MessageRequestHandler<UserMessage>
Description
Resends a failed message.

Overrides BaseChannel.resendMessage

resendUserMessage

resendUserMessage(failedMessage): Promise<UserMessage>
Parameters
- failedMessage: UserMessage
Returns Promise<UserMessage>
Deprecated
since v4.9.8. Use resendMessage() instead.

Description
Resends a failed user message.

Inherited from BaseChannel.resendUserMessage

resetMyHistory

resetMyHistory(): Promise<GroupChannel>
Returns Promise<GroupChannel>
Description
Resets the chat history of this channel for the current user. After this call, the messages created before the call will not be loaded.

sendFileMessage

sendFileMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: FileMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Sends a file with given file information.

Overrides BaseChannel.sendFileMessage

sendFileMessages

sendFileMessages(paramsList): MessageRequestHandler<SendableMessage>
Parameters
- paramsList: FileMessageCreateParams[]
Returns MessageRequestHandler<SendableMessage>
Description
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.

Inherited from BaseChannel.sendFileMessages

sendMultipleFilesMessage

sendMultipleFilesMessage(params): MultipleFilesMessageRequestHandler<SendableMessage>
Parameters
- params: MultipleFilesMessageCreateParams
Returns MultipleFilesMessageRequestHandler<SendableMessage>
Description
Sends a multiple files or file URLs as a single MultipleFilesMessage.

Overrides BaseChannel.sendMultipleFilesMessage

sendScheduledMessageNow

sendScheduledMessageNow(scheduledMessageId): Promise<void>
Parameters
- scheduledMessageId: number
Returns Promise<void>
Description
Sends a scheduled message now.

sendUserMessage

sendUserMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: UserMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Sends a user message.

Overrides BaseChannel.sendUserMessage

serialize

serialize(): object
Returns object
Description
Serializes a GroupChannel instance. The instance can be restored by GroupChannelModule.buildGroupChannelFromSerializedData.

setMyCountPreference

setMyCountPreference(preference): Promise<CountPreference>
Parameters
- preference: CountPreference
Returns Promise<CountPreference>
Description
Sets my count preference for this channel.

setMyPushTriggerOption

setMyPushTriggerOption(option): Promise<PushTriggerOption>
Parameters
- option: PushTriggerOption
Returns Promise<PushTriggerOption>
Description
Sets push trigger option of this channel. If channel's push trigger option is set to PushTriggerOption.DEFAULT, it works according to the state of PushTriggerOption. If not, push messages will be triggered according to the state of PushTriggerOption.

startTyping

startTyping(): Promise<void>
Returns Promise<void>
Description
Sends start typing event.

translateUserMessage

translateUserMessage(targetMessage, languages): Promise<UserMessage>
Parameters
- targetMessage: UserMessage
- languages: string[]
Returns Promise<UserMessage>
Description
Translates a user message.

Inherited from BaseChannel.translateUserMessage

unbanUser

unbanUser(user): Promise<void>
Parameters
- user: User
Returns Promise<void>
Description
Unbans User. Operators can unban User who has been banned from this channel.

Inherited from BaseChannel.unbanUser

unbanUserWithUserId

unbanUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>
Description
Unbans User with userId.

Inherited from BaseChannel.unbanUserWithUserId

unfreeze

unfreeze(): Promise<void>
Returns Promise<void>
Description
Unfreezes the channel.

Overrides BaseChannel.unfreeze

unhide

unhide(): Promise<GroupChannel>
Returns Promise<GroupChannel>
Description
Unhides this channel from the current User's GroupChannel list.

unmuteUser

unmuteUser(user): Promise<void>
Parameters
- user: User
Returns Promise<void>
Description
Unmutes User. The unmuted user could send a message again.

Inherited from BaseChannel.unmuteUser

unmuteUserWithUserId

unmuteUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>
Description
Unmutes User with userId. The unmuted user could send a message again.

Inherited from BaseChannel.unmuteUserWithUserId

unpinMessage

unpinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>
Description
Removes the message from the channel's pinned messages.

Inherited from BaseChannel.unpinMessage

updateChannel

updateChannel(params): Promise<GroupChannel>
Parameters
- params: GroupChannelUpdateParams
Returns Promise<GroupChannel>
Description
Update this channel with GroupChannelUpdateParams.

updateFileMessage

updateFileMessage(messageId, params): Promise<FileMessage>
Parameters
- messageId: number
- params: FileMessageUpdateParams
Returns Promise<FileMessage>
Description
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.

Overrides BaseChannel.updateFileMessage

updateMetaCounters

updateMetaCounters(data, upsert?): Promise<MetaCounter>
Parameters
- data: MetaCounter
- upsert: boolean = false
Returns Promise<MetaCounter>
Description
Updates meta counters.

Inherited from BaseChannel.updateMetaCounters

updateMetaData

updateMetaData(data, upsert?): Promise<MetaData>
Parameters
- data: MetaData
- upsert: boolean = false
Returns Promise<MetaData>
Description
Updates meta data.

Inherited from BaseChannel.updateMetaData

updatePoll

updatePoll(pollId, params): Promise<Poll>
Parameters
- pollId: number
- params: PollUpdateParams
Returns Promise<Poll>
Description
Updates fields of this poll with given params. Once updated successfully, a non-null Poll instance will be passed to the result.

Inherited from BaseChannel.updatePoll

updatePollOption

updatePollOption(pollId, pollOptionId, optionText): Promise<Poll>
Parameters
- pollId: number
- pollOptionId: number
- optionText: string
Returns Promise<Poll>
Description
Updates optionText fields of this poll option. Once updated successfully, a non-null Poll instance will be passed to the result.

Inherited from BaseChannel.updatePollOption

updateScheduledFileMessage

updateScheduledFileMessage(scheduledMessageId, params): Promise<FileMessage>
Parameters
- scheduledMessageId: number
- params: ScheduledFileMessageUpdateParams
Returns Promise<FileMessage>
Description
Update a scheduled file message with scheduledMessageId and ScheduledFileMessageUpdateParams.

updateScheduledUserMessage

updateScheduledUserMessage(scheduledMessageId, params): Promise<UserMessage>
Parameters
- scheduledMessageId: number
- params: ScheduledUserMessageUpdateParams
Returns Promise<UserMessage>
Description
Update a scheduled user message with scheduledMessageId and ScheduledUserMessageUpdateParams.

updateUserMessage

updateUserMessage(messageId, params): Promise<UserMessage>
Parameters
- messageId: number
- params: UserMessageUpdateParams
Returns Promise<UserMessage>
Description
Updates a UserMessage that was previously sent in the channel.

Overrides BaseChannel.updateUserMessage

uploadFile

uploadFile(params): Promise<FileUploadResult>
Parameters
- params: FileUploadParams
Returns Promise<FileUploadResult>
Description
Uploads a file and gets the URL and thumbnails. It takes progressHandler as a parameter to keep track of upload progress.

Inherited from BaseChannel.uploadFile

votePoll

votePoll(pollId, pollOptionIds): Promise<PollVoteEvent>
Parameters
- pollId: number
- pollOptionIds: number[]
Returns Promise<PollVoteEvent>
Description
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.

Inherited from BaseChannel.votePoll

ClassGroupChannel

Description

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

channelType

coverUrl

creator

customType

data

hiddenState

invitedAt

inviter

ReadonlyisAccessCodeRequired

ReadonlyisBroadcast

ReadonlyisChatNotification

ReadonlyisDiscoverable

ReadonlyisDistinct

isEphemeral

ReadonlyisExclusive

isFrozen

ReadonlyisPublic

ReadonlyisPushEnabled

Deprecated

ReadonlyisSuper

joinedAt

joinedMemberCount

lastMessage

lastPinnedMessage

memberCount

members

messageOffsetTimestamp

myCountPreference

myLastRead

myMemberState

myMutedState

myPushTriggerOption

myRole

pinnedMessageIds

totalUnreadReplyCount

unreadMentionCount

unreadMessageCount

Accessors

cachedMetaData

Returns object

cachedUndeliveredMemberState

Returns object

cachedUnreadMemberState

Returns object

createdAt

Returns number

hasAiBot

Returns boolean

hasBot

Returns boolean

isHidden

Returns boolean

isTyping

Returns boolean

messageCollectionLastAccessedAt

Returns number

name

Returns string

Parameters

Returns void

url

Returns string

Methods

acceptInvitation

Parameters

Returns Promise<GroupChannel>

Description

addMessageMetaArrayValues

Parameters

Returns Promise<BaseMessage>

Description

addOperators

`Readonly`isAccessCodeRequired

`Readonly`isBroadcast

`Readonly`isChatNotification

`Readonly`isDiscoverable

`Readonly`isDistinct

`Readonly`isExclusive

`Readonly`isPublic

`Readonly`isPushEnabled

`Readonly`isSuper