Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

Accessors

Properties

Methods

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

    • accessCode: string = null

    Returns Promise<GroupChannel>

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

    Returns void

  • addOperators(userIds: string[]): Promise<void>
  • addPollOption(pollId: number, optionText: string): Promise<default>
  • Parameters

    • pollId: number
    • optionText: string

    Returns Promise<default>

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

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

    Returns Promise<void>

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

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

    Returns Promise<void>

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

    • scheduledMessageId: number

    Returns Promise<void>

  • cancelUploadingFileMessage(requestId: string): Promise<boolean>
  • closePoll(pollId: number): Promise<default>
  • Parameters

    • pollId: number

    Returns Promise<default>

  • createPollListQuery(limit?: number): default
  • Parameters

    • limit: number = DEFAULT_POLLS_LIMIT

    Returns default

  • createPollVoterListQuery(pollId: number, pollOptionId: number, limit?: number): default
  • Parameters

    • pollId: number
    • pollOptionId: number
    • limit: number = DEFAULT_POLL_VOTER_LIST_LIMIT

    Returns default

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

  • deleteAllMetaCounters(): Promise<void>
  • deleteAllMetaData(): Promise<void>
  • deleteMetaCounter(key: string): Promise<void>
  • deleteMetaData(key: string): Promise<void>
  • deletePoll(pollId: number): Promise<void>
  • Parameters

    • pollId: number

    Returns Promise<void>

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

    • pollId: number
    • pollOptionId: number

    Returns Promise<void>

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

  • freeze(): Promise<void>
  • getMetaData(keys: string[]): Promise<MetaData>
  • getPollChangeLogsSinceTimestamp(ts: number): Promise<default>
  • Parameters

    • ts: number

    Returns Promise<default>

  • getPollChangeLogsSinceToken(token: string): Promise<default>
  • Parameters

    • token: string

    Returns Promise<default>

  • getReadStatus(includeAllMembers?: boolean): {}
  • Parameters

    • includeAllMembers: boolean = false

    Returns {}

  • getUndeliveredMemberCount(message: BaseMessage): number
  • invalidateTypingStatus(): boolean
  • Returns boolean

  • Parameters

    • accessCode: string = null

    Returns Promise<GroupChannel>

  • leave(shouldRemoveOperatorStatus?: boolean): Promise<void>
  • Parameters

    • shouldRemoveOperatorStatus: boolean = false

    Returns Promise<void>

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

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

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

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

    Returns Promise<void>

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

    • messageId: number

    Returns Promise<void>

  • removeMember(memberOrUserId: string | Member): boolean
  • Parameters

    • memberOrUserId: string | Member

    Returns boolean

  • removeOperators(userIds: string[]): Promise<void>
  • reportMessage(message: default, category: ReportCategory, description: string): Promise<void>
  • sendScheduledMessageNow(scheduledMessageId: number): Promise<void>
  • Parameters

    • scheduledMessageId: number

    Returns Promise<void>

  • serialize(): object
  • Returns object

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

  • unbanUser(user: User): Promise<void>
  • unbanUserWithUserId(userId: string): Promise<void>
  • unfreeze(): Promise<void>
  • unmuteUser(user: User): Promise<void>
  • unmuteUserWithUserId(userId: string): Promise<void>
  • unpinMessage(messageId: number): Promise<void>
  • Parameters

    • messageId: number

    Returns Promise<void>

  • updatePoll(pollId: number, params: default): Promise<default>
  • Parameters

    • pollId: number
    • params: default

    Returns Promise<default>

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

    • pollId: number
    • pollOptionId: number
    • optionText: string

    Returns Promise<default>

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

    • pollId: number
    • pollOptionIds: number[]

    Returns Promise<default>

Accessors

  • get cachedMetaData(): object
  • Returns object

  • get cachedUndeliveredMemberState(): object
  • Returns object

  • get cachedUnreadMemberState(): object
  • Returns object

  • get isHidden(): boolean
  • Returns boolean

  • get isTyping(): boolean
  • Returns boolean

Properties

channelType: ChannelType = ChannelType.BASE
coverUrl: string = ''
createdAt: number = 0
creator: User = null
customType: string = ''
data: string = ''
hiddenState: HiddenState = HiddenState.UNHIDDEN
invitedAt: number = 0
inviter: User = null
isAccessCodeRequired: boolean = false
isBroadcast: boolean = false
isDiscoverable: boolean = true
isDistinct: boolean = false
isEphemeral: boolean = false
isExclusive: boolean = false
isFrozen: boolean = false
isPublic: boolean = false
isPushEnabled: boolean = false
deprecated
isSuper: boolean = false
joinedAt: number = 0
joinedMemberCount: number = 0
lastMessage: BaseMessage = null
lastPinnedMessage: BaseMessage = null
memberCount: number = 0
members: Member[] = []
messageOffsetTimestamp: number = 0
messageSurvivalSeconds: number = -1
myCountPreference: CountPreference = CountPreference.ALL
myLastRead: number = 0
myMemberState: MemberState = MemberState.NONE
myMutedState: MutedState = MutedState.UNMUTED
myPushTriggerOption: PushTriggerOption = PushTriggerOption.DEFAULT
myRole: Role = Role.NONE
name: string = ''
pinnedMessageIds: number[] = []
unreadMentionCount: number = 0
unreadMessageCount: number = 0
url: string = ''

Generated using TypeDoc