Class GroupChannel

Hierarchy

BaseChannel
- GroupChannel

Index

Accessors

cachedMetaData cachedUndeliveredMemberState cachedUnreadMemberState createdAt isHidden isTyping messageCollectionLastAccessedAt name url

Methods

acceptInvitation addMember 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 declineInvitation decreaseMetaCounters delete deleteAllMetaCounters deleteAllMetaData deleteMessage deleteMessageMetaArrayKeys deleteMetaCounter deleteMetaData deletePoll deletePollOption deleteReaction endTyping freeze getAllMetaCounters getAllMetaData getMessageChangeLogsSinceTimestamp getMessageChangeLogsSinceToken getMessagesByMessageId getMessagesByTimestamp getMetaCounters getMetaData getMyMutedInfo getMyPushTriggerOption getPollChangeLogsSinceTimestamp getPollChangeLogsSinceToken getReadMembers getReadStatus getTypingUsers getUndeliveredMemberCount getUnreadMemberCount getUnreadMembers hide increaseMetaCounters invalidateTypingStatus invite inviteWithUserIds isEqual isFeedChannel isGroupChannel isIdentical isOpenChannel isReadMessage join leave markAsDelivered markAsRead muteUser muteUserWithUserId pinMessage refresh removeMember 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 votePoll

Properties

channelType

channelType: ChannelType = ChannelType.BASE

coverUrl

coverUrl: string = ''

creator

creator: null | User = null

customType

customType: string = ''

data

data: string = ''

hiddenState

hiddenState: HiddenState = HiddenState.UNHIDDEN

invitedAt

invitedAt: number = 0

inviter

inviter: null | User = null

`Readonly` isAccessCodeRequired

isAccessCodeRequired: boolean = false

`Readonly` isBroadcast

isBroadcast: boolean = false

`Readonly` isChatNotification

isChatNotification: boolean = false

`Readonly` isDiscoverable

isDiscoverable: boolean = true

`Readonly` isDistinct

isDistinct: boolean = false

isEphemeral

isEphemeral: boolean = false

`Readonly` isExclusive

isExclusive: boolean = false

isFrozen

isFrozen: boolean = false

`Readonly` isPublic

isPublic: boolean = false

`Readonly` isPushEnabled

isPushEnabled: boolean = false

Deprecated

`Readonly` isSuper

isSuper: boolean = false

joinedAt

joinedAt: number = 0

joinedMemberCount

joinedMemberCount: number = 0

lastMessage

lastMessage: null | BaseMessage = null

lastPinnedMessage

lastPinnedMessage: null | BaseMessage = null

memberCount

memberCount: number = 0

members

members: Member[] = []

messageOffsetTimestamp

messageOffsetTimestamp: number = 0

messageSurvivalSeconds

messageSurvivalSeconds: number = -1

myCountPreference

myCountPreference: CountPreference = CountPreference.ALL

myLastRead

myLastRead: number = 0

myMemberState

myMemberState: MemberState = MemberState.NONE

myMutedState

myMutedState: MutedState = MutedState.UNMUTED

myPushTriggerOption

myPushTriggerOption: PushTriggerOption = PushTriggerOption.DEFAULT

myRole

myRole: Role = Role.NONE

pinnedMessageIds

pinnedMessageIds: number[] = []

unreadMentionCount

unreadMentionCount: number = 0

unreadMessageCount

unreadMessageCount: number = 0

Accessors

cachedMetaData

get cachedMetaData(): object
Returns object

Inherited from BaseChannel.cachedMetaData

cachedUndeliveredMemberState

get cachedUndeliveredMemberState(): object
Returns object

cachedUnreadMemberState

get cachedUnreadMemberState(): object
Returns object

createdAt

get createdAt(): number
Returns number

Inherited from BaseChannel.createdAt

isHidden

get isHidden(): boolean
Returns boolean

isTyping

get isTyping(): boolean
Returns boolean

messageCollectionLastAccessedAt

get messageCollectionLastAccessedAt(): number
Returns number

Inherited from BaseChannel.messageCollectionLastAccessedAt

name

get name(): string
Returns string

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

Inherited from BaseChannel.name

url

get url(): string
Returns string

Inherited from BaseChannel.url

Methods

acceptInvitation

acceptInvitation(accessCode?): Promise<GroupChannel>
Parameters
- Optional accessCode: string
Returns Promise<GroupChannel>

addMember

addMember(member, ts?): void
Parameters
- member: Member
- ts: number = 0
Returns void

addMessageMetaArrayValues

addMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>

Inherited from BaseChannel.addMessageMetaArrayValues

addOperators

addOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>

Inherited from BaseChannel.addOperators

addPollOption

addPollOption(pollId, optionText): Promise<Poll>
Parameters
- pollId: number
- optionText: string
Returns Promise<Poll>

Inherited from BaseChannel.addPollOption

addReaction

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

Inherited from BaseChannel.addReaction

banUser

banUser(user, duration?, description?): Promise<void>
Parameters
- user: User
- Optional duration: number
- Optional description: string
Returns Promise<void>

Inherited from BaseChannel.banUser

banUserWithUserId

banUserWithUserId(userId, duration?, description?): Promise<void>
Parameters
- userId: string
- Optional duration: number
- Optional description: string
Returns Promise<void>

Inherited from BaseChannel.banUserWithUserId

cancelScheduledMessage

cancelScheduledMessage(scheduledMessageId): Promise<void>
Parameters
- scheduledMessageId: number
Returns Promise<void>

cancelUploadingFileMessage

cancelUploadingFileMessage(requestId): Promise<boolean>
Parameters
- requestId: string
Returns Promise<boolean>

Inherited from BaseChannel.cancelUploadingFileMessage

closePoll

closePoll(pollId): Promise<Poll>
Parameters
- pollId: number
Returns Promise<Poll>

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.

Inherited from BaseChannel.copyFileMessage

copyMessage

copyMessage(channel, message): MessageRequestHandler<MultipleFilesMessage>
Parameters
- channel: GroupChannel
- message: MultipleFilesMessage
Returns MessageRequestHandler<MultipleFilesMessage>

Overrides BaseChannel.copyMessage
copyMessage(channel, message): MessageRequestHandler<FileMessage>
Parameters
- channel: BaseChannel
- message: FileMessage
Returns MessageRequestHandler<FileMessage>

Overrides BaseChannel.copyMessage
copyMessage(channel, message): MessageRequestHandler<UserMessage>
Parameters
- channel: BaseChannel
- message: UserMessage
Returns MessageRequestHandler<UserMessage>

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.

Inherited from BaseChannel.copyUserMessage

createBannedUserListQuery

createBannedUserListQuery(params?): BannedUserListQuery
Parameters
- params: BannedUserListQueryParams = {}
Returns BannedUserListQuery

Inherited from BaseChannel.createBannedUserListQuery

createMemberListQuery

createMemberListQuery(params?): MemberListQuery
Parameters
- params: MemberListQueryParams = {}
Returns MemberListQuery

createMessageCollection

createMessageCollection(params?): MessageCollection
Parameters
- params: MessageCollectionParams = {}
Returns MessageCollection

createMessageMetaArrayKeys

createMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>

Inherited from BaseChannel.createMessageMetaArrayKeys

createMetaCounters

createMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

Inherited from BaseChannel.createMetaCounters

createMetaData

createMetaData(data): Promise<MetaData>
Parameters
- data: MetaData
Returns Promise<MetaData>

Inherited from BaseChannel.createMetaData

createMutedUserListQuery

createMutedUserListQuery(params?): MutedUserListQuery
Parameters
- params: MutedUserListQueryParams = {}
Returns MutedUserListQuery

Inherited from BaseChannel.createMutedUserListQuery

createOperatorListQuery

createOperatorListQuery(params?): OperatorListQuery
Parameters
- params: OperatorListQueryParams = {}
Returns OperatorListQuery

Inherited from BaseChannel.createOperatorListQuery

createPinnedMessageListQuery

createPinnedMessageListQuery(params?): PinnedMessageListQuery
Parameters
- params: PinnedMessageListQueryParams = {}
Returns PinnedMessageListQuery

createPollListQuery

createPollListQuery(limit?): PollListQuery
Parameters
- limit: number = DEFAULT_POLLS_LIMIT
Returns PollListQuery

Inherited from BaseChannel.createPollListQuery

createPollVoterListQuery

createPollVoterListQuery(pollId, pollOptionId, limit?): PollVoterListQuery
Parameters
- pollId: number
- pollOptionId: number
- limit: number = DEFAULT_POLL_VOTER_LIST_LIMIT
Returns PollVoterListQuery

Inherited from BaseChannel.createPollVoterListQuery

createPreviousMessageListQuery

createPreviousMessageListQuery(params?): PreviousMessageListQuery
Parameters
- params: PreviousMessageListQueryParams = {}
Returns PreviousMessageListQuery

Inherited from BaseChannel.createPreviousMessageListQuery

createScheduledFileMessage

createScheduledFileMessage(params): MessageRequestHandler<default>
Parameters
- params: ScheduledFileMessageCreateParams
Returns MessageRequestHandler<default>

createScheduledUserMessage

createScheduledUserMessage(params): MessageRequestHandler<default>
Parameters
- params: ScheduledUserMessageCreateParams
Returns MessageRequestHandler<default>

declineInvitation

declineInvitation(): Promise<GroupChannel>
Returns Promise<GroupChannel>

decreaseMetaCounters

decreaseMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

Inherited from BaseChannel.decreaseMetaCounters

delete

delete(): Promise<void>
Returns Promise<void>

deleteAllMetaCounters

deleteAllMetaCounters(): Promise<void>
Returns Promise<void>

Inherited from BaseChannel.deleteAllMetaCounters

deleteAllMetaData

deleteAllMetaData(): Promise<void>
Returns Promise<void>

Inherited from BaseChannel.deleteAllMetaData

deleteMessage

deleteMessage(message): Promise<void>
Parameters
- message: BaseMessage
Returns Promise<void>

Overrides BaseChannel.deleteMessage

deleteMessageMetaArrayKeys

deleteMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>

Inherited from BaseChannel.deleteMessageMetaArrayKeys

deleteMetaCounter

deleteMetaCounter(key): Promise<void>
Parameters
- key: string
Returns Promise<void>

Inherited from BaseChannel.deleteMetaCounter

deleteMetaData

deleteMetaData(key): Promise<void>
Parameters
- key: string
Returns Promise<void>

Inherited from BaseChannel.deleteMetaData

deletePoll

deletePoll(pollId): Promise<void>
Parameters
- pollId: number
Returns Promise<void>

Inherited from BaseChannel.deletePoll

deletePollOption

deletePollOption(pollId, pollOptionId): Promise<void>
Parameters
- pollId: number
- pollOptionId: number
Returns Promise<void>

Inherited from BaseChannel.deletePollOption

deleteReaction

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

Inherited from BaseChannel.deleteReaction

endTyping

endTyping(): Promise<void>
Returns Promise<void>

freeze

freeze(): Promise<void>
Returns Promise<void>

Overrides BaseChannel.freeze

getAllMetaCounters

getAllMetaCounters(): Promise<MetaCounter>
Returns Promise<MetaCounter>

Inherited from BaseChannel.getAllMetaCounters

getAllMetaData

getAllMetaData(): Promise<MetaData>
Returns Promise<MetaData>

Inherited from BaseChannel.getAllMetaData

getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceTimestamp(ts, params?): Promise<MessageChangelogs>
Parameters
- ts: number
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>

Inherited from BaseChannel.getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceToken

getMessageChangeLogsSinceToken(token, params?): Promise<MessageChangelogs>
Parameters
- token: string
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>

Inherited from BaseChannel.getMessageChangeLogsSinceToken

getMessagesByMessageId

getMessagesByMessageId(messageId, params): Promise<BaseMessage[]>
Parameters
- messageId: number
- params: MessageListParams
Returns Promise<BaseMessage[]>

Inherited from BaseChannel.getMessagesByMessageId

getMessagesByTimestamp

getMessagesByTimestamp(ts, params): Promise<BaseMessage[]>
Parameters
- ts: number
- params: MessageListParams
Returns Promise<BaseMessage[]>

Inherited from BaseChannel.getMessagesByTimestamp

getMetaCounters

getMetaCounters(keys): Promise<MetaCounter>
Parameters
- keys: string[]
Returns Promise<MetaCounter>

Inherited from BaseChannel.getMetaCounters

getMetaData

getMetaData(keys): Promise<MetaData>
Parameters
- keys: string[]
Returns Promise<MetaData>

Inherited from BaseChannel.getMetaData

getMyMutedInfo

getMyMutedInfo(): Promise<MutedInfo>
Returns Promise<MutedInfo>

Inherited from BaseChannel.getMyMutedInfo

getMyPushTriggerOption

getMyPushTriggerOption(): Promise<PushTriggerOption>
Returns Promise<PushTriggerOption>

getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceTimestamp(ts): Promise<PollChangelogs>
Parameters
- ts: number
Returns Promise<PollChangelogs>

Inherited from BaseChannel.getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceToken

getPollChangeLogsSinceToken(token): Promise<PollChangelogs>
Parameters
- token: null | string
Returns Promise<PollChangelogs>

Inherited from BaseChannel.getPollChangeLogsSinceToken

getReadMembers

getReadMembers(message, includeAllMembers?): Member[]
Parameters
- message: BaseMessage
- includeAllMembers: boolean = false
Returns Member[]

getReadStatus

getReadStatus(includeAllMembers?): null | {
[key: string]: ReadStatus;
}
Parameters
- includeAllMembers: boolean = false
Returns null | {
[key: string]: ReadStatus;
}

getTypingUsers

getTypingUsers(): Member[]
Returns Member[]

getUndeliveredMemberCount

getUndeliveredMemberCount(message): number
Parameters
- message: BaseMessage
Returns number

getUnreadMemberCount

getUnreadMemberCount(message): number
Parameters
- message: BaseMessage
Returns number

getUnreadMembers

getUnreadMembers(message, includeAllMembers?): Member[]
Parameters
- message: BaseMessage
- includeAllMembers: boolean = false
Returns Member[]

hide

hide(params): Promise<GroupChannel>
Parameters
- params: GroupChannelHideParams
Returns Promise<GroupChannel>

increaseMetaCounters

increaseMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

Inherited from BaseChannel.increaseMetaCounters

invalidateTypingStatus

invalidateTypingStatus(): boolean
Returns boolean

invite

invite(users): Promise<GroupChannel>
Parameters
- users: User[]
Returns Promise<GroupChannel>

inviteWithUserIds

inviteWithUserIds(userIds): Promise<GroupChannel>
Parameters
- userIds: string[]
Returns Promise<GroupChannel>

isEqual

isEqual(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean

Inherited from BaseChannel.isEqual

isFeedChannel

isFeedChannel(): this is FeedChannel
Returns this is FeedChannel

Inherited from BaseChannel.isFeedChannel

isGroupChannel

isGroupChannel(): this is GroupChannel
Returns this is GroupChannel

Inherited from BaseChannel.isGroupChannel

isIdentical

isIdentical(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean

Inherited from BaseChannel.isIdentical

isOpenChannel

isOpenChannel(): this is OpenChannel
Returns this is OpenChannel

Inherited from BaseChannel.isOpenChannel

isReadMessage

isReadMessage(message): boolean
Parameters
- message: BaseMessage
Returns boolean

join

join(accessCode?): Promise<GroupChannel>
Parameters
- Optional accessCode: string
Returns Promise<GroupChannel>

leave

leave(shouldRemoveOperatorStatus?): Promise<void>
Parameters
- shouldRemoveOperatorStatus: boolean = false
Returns Promise<void>

markAsDelivered

markAsDelivered(): Promise<void>
Returns Promise<void>

markAsRead

markAsRead(): Promise<void>
Returns Promise<void>

muteUser

muteUser(user, duration?, description?): Promise<void>
Parameters
- user: User
- Optional duration: number
- Optional description: string
Returns Promise<void>

Inherited from BaseChannel.muteUser

muteUserWithUserId

muteUserWithUserId(userId, duration?, description?): Promise<void>
Parameters
- userId: string
- Optional duration: number
- Optional description: string
Returns Promise<void>

Inherited from BaseChannel.muteUserWithUserId

pinMessage

pinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>

refresh

refresh(): Promise<GroupChannel>
Returns Promise<GroupChannel>

removeMember

removeMember(memberOrUserId): boolean
Parameters
- memberOrUserId: string | Member
Returns boolean

removeMessageMetaArrayValues

removeMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>

Inherited from BaseChannel.removeMessageMetaArrayValues

removeOperators

removeOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>

Inherited from BaseChannel.removeOperators

report

report(category, description): Promise<void>
Parameters
- category: ReportCategory
- description: string
Returns Promise<void>

Inherited from BaseChannel.report

reportMessage

reportMessage(message, category, description): Promise<void>
Parameters
- message: default
- category: ReportCategory
- description: string
Returns Promise<void>

Inherited from BaseChannel.reportMessage

reportUser

reportUser(user, category, description): Promise<void>
Parameters
- user: User
- category: ReportCategory
- description: string
Returns Promise<void>

Inherited from BaseChannel.reportUser

resendFileMessage

resendFileMessage(failedMessage, file?): Promise<FileMessage>
Parameters
- failedMessage: FileMessage
- Optional file: FileCompat
Returns Promise<FileMessage>

Deprecated
since v4.9.8. Use resendMessage() instead.

Inherited from BaseChannel.resendFileMessage

resendMessage

resendMessage(failedMessage): MultipleFilesMessageRequestHandler<MultipleFilesMessage>
Parameters
- failedMessage: MultipleFilesMessage
Returns MultipleFilesMessageRequestHandler<MultipleFilesMessage>

Overrides BaseChannel.resendMessage
resendMessage(failedMessage, file?): MessageRequestHandler<FileMessage>
Parameters
- failedMessage: FileMessage
- Optional file: FileCompat
Returns MessageRequestHandler<FileMessage>

Overrides BaseChannel.resendMessage
resendMessage(failedMessage): MessageRequestHandler<UserMessage>
Parameters
- failedMessage: UserMessage
Returns MessageRequestHandler<UserMessage>

Overrides BaseChannel.resendMessage

resendUserMessage

resendUserMessage(failedMessage): Promise<UserMessage>
Parameters
- failedMessage: UserMessage
Returns Promise<UserMessage>

Deprecated
since v4.9.8. Use resendMessage() instead.

Inherited from BaseChannel.resendUserMessage

resetMyHistory

resetMyHistory(): Promise<GroupChannel>
Returns Promise<GroupChannel>

sendFileMessage

sendFileMessage(params): MessageRequestHandler<default>
Parameters
- params: FileMessageCreateParams
Returns MessageRequestHandler<default>

Overrides BaseChannel.sendFileMessage

sendFileMessages

sendFileMessages(paramsList): MessageRequestHandler<default>
Parameters
- paramsList: FileMessageCreateParams[]
Returns MessageRequestHandler<default>

Inherited from BaseChannel.sendFileMessages

sendMultipleFilesMessage

sendMultipleFilesMessage(params): MultipleFilesMessageRequestHandler<default>
Parameters
- params: MultipleFilesMessageCreateParams
Returns MultipleFilesMessageRequestHandler<default>

Overrides BaseChannel.sendMultipleFilesMessage

sendScheduledMessageNow

sendScheduledMessageNow(scheduledMessageId): Promise<void>
Parameters
- scheduledMessageId: number
Returns Promise<void>

sendUserMessage

sendUserMessage(params): MessageRequestHandler<default>
Parameters
- params: UserMessageCreateParams
Returns MessageRequestHandler<default>

Overrides BaseChannel.sendUserMessage

serialize

serialize(): object
Returns object

setMyCountPreference

setMyCountPreference(preference): Promise<CountPreference>
Parameters
- preference: CountPreference
Returns Promise<CountPreference>

setMyPushTriggerOption

setMyPushTriggerOption(option): Promise<PushTriggerOption>
Parameters
- option: PushTriggerOption
Returns Promise<PushTriggerOption>

startTyping

startTyping(): Promise<void>
Returns Promise<void>

translateUserMessage

translateUserMessage(targetMessage, languages): Promise<UserMessage>
Parameters
- targetMessage: UserMessage
- languages: string[]
Returns Promise<UserMessage>

Inherited from BaseChannel.translateUserMessage

unbanUser

unbanUser(user): Promise<void>
Parameters
- user: User
Returns Promise<void>

Inherited from BaseChannel.unbanUser

unbanUserWithUserId

unbanUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>

Inherited from BaseChannel.unbanUserWithUserId

unfreeze

unfreeze(): Promise<void>
Returns Promise<void>

Overrides BaseChannel.unfreeze

unhide

unhide(): Promise<GroupChannel>
Returns Promise<GroupChannel>

unmuteUser

unmuteUser(user): Promise<void>
Parameters
- user: User
Returns Promise<void>

Inherited from BaseChannel.unmuteUser

unmuteUserWithUserId

unmuteUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>

Inherited from BaseChannel.unmuteUserWithUserId

unpinMessage

unpinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>

updateChannel

updateChannel(params): Promise<GroupChannel>
Parameters
- params: GroupChannelUpdateParams
Returns Promise<GroupChannel>

updateFileMessage

updateFileMessage(messageId, params): Promise<FileMessage>
Parameters
- messageId: number
- params: FileMessageUpdateParams
Returns Promise<FileMessage>

Overrides BaseChannel.updateFileMessage

updateMetaCounters

updateMetaCounters(data, upsert?): Promise<MetaCounter>
Parameters
- data: MetaCounter
- upsert: boolean = false
Returns Promise<MetaCounter>

Inherited from BaseChannel.updateMetaCounters

updateMetaData

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

Inherited from BaseChannel.updateMetaData

updatePoll

updatePoll(pollId, params): Promise<Poll>
Parameters
- pollId: number
- params: PollUpdateParams
Returns Promise<Poll>

Inherited from BaseChannel.updatePoll

updatePollOption

updatePollOption(pollId, pollOptionId, optionText): Promise<Poll>
Parameters
- pollId: number
- pollOptionId: number
- optionText: string
Returns Promise<Poll>

Inherited from BaseChannel.updatePollOption

updateScheduledFileMessage

updateScheduledFileMessage(scheduledMessageId, params): Promise<FileMessage>
Parameters
- scheduledMessageId: number
- params: ScheduledFileMessageUpdateParams
Returns Promise<FileMessage>

updateScheduledUserMessage

updateScheduledUserMessage(scheduledMessageId, params): Promise<UserMessage>
Parameters
- scheduledMessageId: number
- params: ScheduledUserMessageUpdateParams
Returns Promise<UserMessage>

updateUserMessage

updateUserMessage(messageId, params): Promise<UserMessage>
Parameters
- messageId: number
- params: UserMessageUpdateParams
Returns Promise<UserMessage>

Overrides BaseChannel.updateUserMessage

votePoll

votePoll(pollId, pollOptionIds): Promise<PollVoteEvent>
Parameters
- pollId: number
- pollOptionIds: number[]
Returns Promise<PollVoteEvent>

Inherited from BaseChannel.votePoll

Class GroupChannel

Hierarchy

Index

Properties

Accessors

Methods

Properties

channelType

coverUrl

creator

customType

data

hiddenState

invitedAt

inviter

Readonly isAccessCodeRequired

Readonly isBroadcast

Readonly isChatNotification

Readonly isDiscoverable

Readonly isDistinct

isEphemeral

Readonly isExclusive

isFrozen

Readonly isPublic

Readonly isPushEnabled

Deprecated

Readonly isSuper

joinedAt

joinedMemberCount

lastMessage

lastPinnedMessage

memberCount

members

messageOffsetTimestamp

messageSurvivalSeconds

myCountPreference

myLastRead

myMemberState

myMutedState

myPushTriggerOption

myRole

pinnedMessageIds

unreadMentionCount

unreadMessageCount

Accessors

cachedMetaData

Returns object

cachedUndeliveredMemberState

Returns object

cachedUnreadMemberState

Returns object

createdAt

Returns number

isHidden

Returns boolean

isTyping

Returns boolean

messageCollectionLastAccessedAt

Returns number

name

Returns string

Parameters

value: string

Returns void

url

Returns string

Methods

acceptInvitation

Parameters

Optional accessCode: string

Returns Promise<GroupChannel>

addMember

Parameters

member: Member

ts: number = 0

Returns void

addMessageMetaArrayValues

Parameters

message: BaseMessage

metaArrays: MessageMetaArray[]

`Readonly` isAccessCodeRequired

`Readonly` isBroadcast

`Readonly` isChatNotification

`Readonly` isDiscoverable

`Readonly` isDistinct

`Readonly` isExclusive

`Readonly` isPublic

`Readonly` isPushEnabled

`Readonly` isSuper

`Optional` accessCode: string

`Optional` duration: number

`Optional` description: string

`Optional` duration: number

`Optional` description: string