Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupChannel

Hierarchy

Index

Methods

Accessors

Properties

Methods

acceptInvitation

  • acceptInvitation(accessCode?: string): Promise<GroupChannel>

  • Parameters

    • accessCode: string = null

    Returns Promise<GroupChannel>

addMember

  • addMember(member: Member, ts?: number): void

  • Parameters

    Returns void

addMessageMetaArrayValues

addOperators

  • addOperators(userIds: string[]): Promise<void>

addPollOption

  • addPollOption(pollId: number, optionText: string): Promise<Poll>

addReaction

banUser

  • banUser(user: User, duration?: number, description?: string): Promise<void>

  • Parameters

    • user: User
    • Optional duration: number
    • Optional description: string

    Returns Promise<void>

banUserWithUserId

  • banUserWithUserId(userId: string, duration?: number, description?: string): Promise<void>

  • Parameters

    • userId: string
    • Optional duration: number
    • Optional description: string

    Returns Promise<void>

cancelScheduledMessage

  • cancelScheduledMessage(scheduledMessageId: number): Promise<void>

  • Parameters

    • scheduledMessageId: number

    Returns Promise<void>

cancelUploadingFileMessage

  • cancelUploadingFileMessage(requestId: string): Promise<boolean>

closePoll

  • closePoll(pollId: number): Promise<Poll>

copyFileMessage

copyUserMessage

createBannedUserListQuery

createMemberListQuery

createMessageCollection

createMessageMetaArrayKeys

createMetaCounters

createMetaData

createMutedUserListQuery

createOperatorListQuery

createPinnedMessageListQuery

createPollListQuery

createPollVoterListQuery

  • createPollVoterListQuery(pollId: number, pollOptionId: number, limit?: number): PollVoterListQuery

createPreviousMessageListQuery

createScheduledFileMessage

createScheduledUserMessage

declineInvitation

decreaseMetaCounters

delete

  • delete(): Promise<void>

  • Returns Promise<void>

deleteAllMetaCounters

  • deleteAllMetaCounters(): Promise<void>

deleteAllMetaData

  • deleteAllMetaData(): Promise<void>

deleteMessage

deleteMessageMetaArrayKeys

deleteMetaCounter

  • deleteMetaCounter(key: string): Promise<void>

deleteMetaData

  • deleteMetaData(key: string): Promise<void>

deletePoll

  • deletePoll(pollId: number): Promise<void>

deletePollOption

  • deletePollOption(pollId: number, pollOptionId: number): Promise<void>

deleteReaction

endTyping

  • endTyping(): Promise<void>

  • Returns Promise<void>

freeze

  • freeze(): Promise<void>

getAllMetaCounters

getAllMetaData

getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceToken

getMessagesByMessageId

getMessagesByTimestamp

getMetaCounters

getMetaData

  • getMetaData(keys: string[]): Promise<MetaData>

getMyMutedInfo

getMyPushTriggerOption

getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceToken

getReadMembers

getReadStatus

  • getReadStatus(includeAllMembers?: boolean): {}

  • Parameters

    • includeAllMembers: boolean = false

    Returns {}

getTypingUsers

getUndeliveredMemberCount

  • getUndeliveredMemberCount(message: BaseMessage): number

getUnreadMemberCount

getUnreadMembers

hide

increaseMetaCounters

invalidateTypingStatus

  • invalidateTypingStatus(): boolean

  • Returns boolean

invite

inviteWithUserIds

isEqual

isGroupChannel

isIdentical

isOpenChannel

isReadMessage

join

  • Parameters

    • accessCode: string = null

    Returns Promise<GroupChannel>

leave

  • leave(shouldRemoveOperatorStatus?: boolean): 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: User, duration?: number, description?: string): Promise<void>

  • Parameters

    • user: User
    • Optional duration: number
    • Optional description: string

    Returns Promise<void>

muteUserWithUserId

  • muteUserWithUserId(userId: string, duration?: number, description?: string): Promise<void>

pinMessage

  • pinMessage(messageId: number): Promise<void>

  • Parameters

    • messageId: number

    Returns Promise<void>

refresh

removeMember

  • removeMember(memberOrUserId: string | Member): boolean

  • Parameters

    • memberOrUserId: string | Member

    Returns boolean

removeMessageMetaArrayValues

removeOperators

  • removeOperators(userIds: string[]): Promise<void>

report

reportMessage

  • reportMessage(message: default, category: ReportCategory, description: string): Promise<void>

reportUser

resendFileMessage

resendUserMessage

resetMyHistory

sendFileMessage

sendFileMessages

sendScheduledMessageNow

  • sendScheduledMessageNow(scheduledMessageId: number): Promise<void>

  • Parameters

    • scheduledMessageId: number

    Returns Promise<void>

sendUserMessage

serialize

  • serialize(): object

  • Returns object

setMyCountPreference

setMyPushTriggerOption

startTyping

  • startTyping(): Promise<void>

  • Returns Promise<void>

translateUserMessage

unbanUser

  • unbanUser(user: User): Promise<void>

unbanUserWithUserId

  • unbanUserWithUserId(userId: string): Promise<void>

unfreeze

  • unfreeze(): Promise<void>

unhide

unmuteUser

  • unmuteUser(user: User): Promise<void>

unmuteUserWithUserId

  • unmuteUserWithUserId(userId: string): Promise<void>

unpinMessage

  • unpinMessage(messageId: number): Promise<void>

  • Parameters

    • messageId: number

    Returns Promise<void>

updateChannel

updateFileMessage

updateMetaCounters

updateMetaData

updatePoll

updatePollOption

  • updatePollOption(pollId: number, pollOptionId: number, optionText: string): Promise<Poll>

updateScheduledFileMessage

updateScheduledUserMessage

updateUserMessage

votePoll

  • votePoll(pollId: number, pollOptionIds: number[]): Promise<PollVoteEvent>

Accessors

cachedMetaData

  • get cachedMetaData(): object

  • Returns object

cachedUndeliveredMemberState

  • get cachedUndeliveredMemberState(): object

  • Returns object

cachedUnreadMemberState

  • get cachedUnreadMemberState(): object

  • Returns object

isHidden

  • get isHidden(): boolean

  • Returns boolean

isTyping

  • get isTyping(): boolean

  • Returns boolean

messageCollectionLastAccessedAt

  • get messageCollectionLastAccessedAt(): number

  • Returns number

Properties

channelType

channelType: ChannelType = ChannelType.BASE

coverUrl

coverUrl: string = ''

createdAt

createdAt: number = 0

creator

creator: User = null

customType

customType: string = ''

data

data: string = ''

hiddenState

hiddenState: HiddenState = HiddenState.UNHIDDEN

invitedAt

invitedAt: number = 0

inviter

inviter: User = null

Readonly isAccessCodeRequired

isAccessCodeRequired: boolean = false

Readonly isBroadcast

isBroadcast: 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: BaseMessage = null

lastPinnedMessage

lastPinnedMessage: 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

name

name: string = ''

pinnedMessageIds

pinnedMessageIds: number[] = []

unreadMentionCount

unreadMentionCount: number = 0

unreadMessageCount

unreadMessageCount: number = 0

url

url: string = ''

Generated using TypeDoc