Hierarchy

Properties

Accessors

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 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 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 uploadFile votePoll

Properties

channelType: ChannelType = ChannelType.BASE
coverUrl: string = ''
creator: null | User = null
customType: string = ''
data: string = ''
hiddenState: HiddenState = HiddenState.UNHIDDEN
invitedAt: number = 0
inviter: null | User = null
isAccessCodeRequired: boolean = false
isBroadcast: boolean = false
isChatNotification: 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: null | BaseMessage = null
lastPinnedMessage: null | 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
pinnedMessageIds: number[] = []
totalUnreadReplyCount: number = 0
unreadMentionCount: number = 0
unreadMessageCount: number = 0

Accessors

  • get cachedMetaData(): object
  • Returns object

  • get cachedUndeliveredMemberState(): object
  • Returns object

  • get cachedUnreadMemberState(): object
  • Returns object

  • get createdAt(): number
  • Returns number

  • get isHidden(): boolean
  • Returns boolean

  • get isTyping(): boolean
  • Returns boolean

  • get messageCollectionLastAccessedAt(): number
  • Returns number

  • get name(): string
  • Returns string

  • set name(value): void
  • Parameters

    • value: string

    Returns void

  • get url(): string
  • Returns string

Methods

  • Parameters

    • Optional accessCode: string

    Returns Promise<GroupChannel>

  • Parameters

    • member: Member
    • ts: number = 0

    Returns void

  • Parameters

    • userIds: string[]

    Returns Promise<void>

  • Parameters

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

    Returns Promise<void>

  • Parameters

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

    Returns Promise<void>

  • Parameters

    • scheduledMessageId: number

    Returns Promise<void>

  • Parameters

    • params: ThreadedParentMessageListQueryParams = {}

    Returns default

  • Returns Promise<void>

  • Parameters

    • pollId: number

    Returns Promise<void>

  • Parameters

    • pollId: number
    • pollOptionId: number

    Returns Promise<void>

  • Returns Promise<void>

  • Parameters

    • includeAllMembers: boolean = true

    Returns null | {
        [key: string]: DeliveryStatus;
    }

  • Parameters

    • message: BaseMessage
    • includeAllMembers: boolean = false

    Returns Member[]

  • Parameters

    • includeAllMembers: boolean = false

    Returns null | {
        [key: string]: ReadStatus;
    }

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    • message: BaseMessage
    • includeAllMembers: boolean = false

    Returns Member[]

  • Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • shouldRemoveOperatorStatus: boolean = false

    Returns Promise<void>

  • Returns Promise<void>

  • Returns Promise<void>

  • Parameters

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

    Returns Promise<void>

  • Parameters

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

    Returns Promise<void>

  • Parameters

    • messageId: number

    Returns Promise<void>

  • Parameters

    • memberOrUserId: string | Member

    Returns boolean

  • Parameters

    • userIds: string[]

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

  • Parameters

    • scheduledMessageId: number

    Returns Promise<void>

  • Returns object

  • Returns Promise<void>

  • Parameters

    • messageId: number

    Returns Promise<void>

  • Parameters

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

    Returns Promise<Poll>

Generated using TypeDoc