Class BaseChannel

Hierarchy

default
- BaseChannel
  - GroupChannel
  - OpenChannel

Index

Methods

Accessors

cachedMetaData

Properties

Methods

addMessageMetaArrayValues

addMessageMetaArrayValues(message: default, metaArrays: MessageMetaArray[]): Promise<BaseMessage>

Parameters
- message: default
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>

addOperators

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

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

addReaction

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

Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>

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>

cancelUploadingFileMessage

cancelUploadingFileMessage(requestId: string): Promise<boolean>

Parameters
- requestId: string
Returns Promise<boolean>

copyFileMessage

copyFileMessage(targetChannel: BaseChannel, message: FileMessage): Promise<FileMessage>

Parameters
- targetChannel: BaseChannel
- message: FileMessage
Returns Promise<FileMessage>

copyUserMessage

copyUserMessage(targetChannel: BaseChannel, message: UserMessage): Promise<UserMessage>

Parameters
- targetChannel: BaseChannel
- message: UserMessage
Returns Promise<UserMessage>

createBannedUserListQuery

createBannedUserListQuery(params?: BannedUserListQueryParams): BannedUserListQuery

Parameters
- params: BannedUserListQueryParams = {}
Returns BannedUserListQuery

createMessageMetaArrayKeys

createMessageMetaArrayKeys(message: default, keys: string[]): Promise<BaseMessage>

Parameters
- message: default
- keys: string[]
Returns Promise<BaseMessage>

createMetaCounters

createMetaCounters(data: MetaCounter): Promise<MetaCounter>

Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

createMetaData

createMetaData(data: MetaData): Promise<MetaData>

Parameters
- data: MetaData
Returns Promise<MetaData>

createMutedUserListQuery

createMutedUserListQuery(params?: MutedUserListQueryParams): MutedUserListQuery

Parameters
- params: MutedUserListQueryParams = {}
Returns MutedUserListQuery

createOperatorListQuery

createOperatorListQuery(params?: OperatorListQueryParams): OperatorListQuery

Parameters
- params: OperatorListQueryParams = {}
Returns OperatorListQuery

createPreviousMessageListQuery

createPreviousMessageListQuery(params?: PreviousMessageListQueryParams): PreviousMessageListQuery

Parameters
- params: PreviousMessageListQueryParams = {}
Returns PreviousMessageListQuery

decreaseMetaCounters

decreaseMetaCounters(data: MetaCounter): Promise<MetaCounter>

Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

deleteAllMetaCounters

deleteAllMetaCounters(): Promise<void>

Returns Promise<void>

deleteAllMetaData

deleteAllMetaData(): Promise<void>

Returns Promise<void>

deleteMessage

deleteMessage(message: default): Promise<void>

Parameters
- message: default
Returns Promise<void>

deleteMessageMetaArrayKeys

deleteMessageMetaArrayKeys(message: default, keys: string[]): Promise<BaseMessage>

Parameters
- message: default
- keys: string[]
Returns Promise<BaseMessage>

deleteMetaCounter

deleteMetaCounter(key: string): Promise<void>

Parameters
- key: string
Returns Promise<void>

deleteMetaData

deleteMetaData(key: string): Promise<void>

Parameters
- key: string
Returns Promise<void>

deleteReaction

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

Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>

freeze

freeze(): Promise<void>

Returns Promise<void>

getAllMetaCounters

getAllMetaCounters(): Promise<MetaCounter>

Returns Promise<MetaCounter>

getAllMetaData

getAllMetaData(): Promise<MetaData>

Returns Promise<MetaData>

getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceTimestamp(ts: number, params: MessageChangeLogsParams): Promise<default>

Parameters
- ts: number
- params: MessageChangeLogsParams
Returns Promise<default>

getMessageChangeLogsSinceToken

getMessageChangeLogsSinceToken(token: string, params: MessageChangeLogsParams): Promise<default>

Parameters
- token: string
- params: MessageChangeLogsParams
Returns Promise<default>

getMessagesByTimestamp

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

Parameters
- ts: number
- params: MessageListParams
Returns Promise<BaseMessage[]>

getMetaCounters

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

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

getMetaData

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

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

getMyMutedInfo

getMyMutedInfo(): Promise<MutedInfo>

Returns Promise<MutedInfo>

increaseMetaCounters

increaseMetaCounters(data: MetaCounter): Promise<MetaCounter>

Parameters
- data: MetaCounter
Returns Promise<MetaCounter>

isEqual

isEqual(channel: BaseChannel): boolean

Parameters
- channel: BaseChannel
Returns boolean

isGroupChannel

isGroupChannel(): this is GroupChannel

Returns this is GroupChannel

isIdentical

isIdentical(channel: BaseChannel): boolean

Parameters
- channel: BaseChannel
Returns boolean

isOpenChannel

isOpenChannel(): this is OpenChannel

Returns this is OpenChannel

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>

Parameters
- userId: string
- Optional duration: number
- Optional description: string
Returns Promise<void>

removeMessageMetaArrayValues

removeMessageMetaArrayValues(message: default, metaArrays: MessageMetaArray[]): Promise<BaseMessage>

Parameters
- message: default
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>

removeOperators

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

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

report

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

Parameters
- category: ReportCategory
- description: string
Returns Promise<void>

reportMessage

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

Parameters
- message: default
- category: ReportCategory
- description: string
Returns Promise<void>

reportUser

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

Parameters
- user: User
- category: ReportCategory
- description: string
Returns Promise<void>

resendFileMessage

resendFileMessage(failedMessage: FileMessage, blob: Blob): Promise<FileMessage>

Parameters
- failedMessage: FileMessage
- blob: Blob
Returns Promise<FileMessage>

resendUserMessage

resendUserMessage(failedMessage: UserMessage): Promise<UserMessage>

Parameters
- failedMessage: UserMessage
Returns Promise<UserMessage>

sendFileMessage

sendFileMessage(params: FileMessageCreateParams): MessageRequestHandler

Parameters
- params: FileMessageCreateParams
Returns MessageRequestHandler

sendFileMessages

sendFileMessages(paramsList: FileMessageCreateParams[]): MessageRequestHandler

Parameters
- paramsList: FileMessageCreateParams[]
Returns MessageRequestHandler

sendUserMessage

sendUserMessage(params: UserMessageCreateParams): MessageRequestHandler

Parameters
- params: UserMessageCreateParams
Returns MessageRequestHandler

translateUserMessage

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

Parameters
- targetMessage: UserMessage
- languages: string[]
Returns Promise<UserMessage>

unbanUser

unbanUser(user: User): Promise<void>

Parameters
- user: User
Returns Promise<void>

unbanUserWithUserId

unbanUserWithUserId(userId: string): Promise<void>

Parameters
- userId: string
Returns Promise<void>

unfreeze

unfreeze(): Promise<void>

Returns Promise<void>

unmuteUser

unmuteUser(user: User): Promise<void>

Parameters
- user: User
Returns Promise<void>

unmuteUserWithUserId

unmuteUserWithUserId(userId: string): Promise<void>

Parameters
- userId: string
Returns Promise<void>

updateFileMessage

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

Parameters
- messageId: number
- params: FileMessageUpdateParams
Returns Promise<FileMessage>

updateMetaCounters

updateMetaCounters(data: MetaCounter, upsert?: boolean): Promise<MetaCounter>

Parameters
- data: MetaCounter
- upsert: boolean = false
Returns Promise<MetaCounter>

updateMetaData

updateMetaData(data: MetaData, upsert?: boolean): Promise<MetaData>

Parameters
- data: MetaData
- upsert: boolean = false
Returns Promise<MetaData>

updateUserMessage

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

Parameters
- messageId: number
- params: UserMessageUpdateParams
Returns Promise<UserMessage>

Accessors

cachedMetaData

get cachedMetaData(): object

Returns object

Properties

channelType

channelType: ChannelType = ChannelType.BASE

coverUrl

coverUrl: string = ''

createdAt

createdAt: number = 0

creator

creator: User = null

customType

customType: string = ''

data

data: string = ''

isEphemeral

isEphemeral: boolean = false

isFrozen

isFrozen: boolean = false

name

name: string = ''

url

url: string = ''

Generated using TypeDoc