Class AdminMessage

Hierarchy

BaseMessage
- AdminMessage

Properties

appleCriticalAlertOptions

appleCriticalAlertOptions: null | AppleCriticalAlertOptions = null

`Readonly` channelType

channelType: ChannelType = ChannelType.BASE

`Readonly` channelUrl

channelUrl: string

createdAt

createdAt: number = 0

customType

customType: string

data

data: string

extendedMessage

extendedMessage: object = {}

isOperatorMessage

isOperatorMessage: boolean = false

mentionType

mentionType: null | MentionType = null

mentionedMessageTemplate

mentionedMessageTemplate: string

mentionedUserIds

mentionedUserIds: null | string[]

mentionedUsers

mentionedUsers: null | User[]

message

message: string

messageId

messageId: number

messageType

messageType: MessageType = MessageType.BASE

metaArrays

metaArrays: MessageMetaArray[] = []

notificationData

notificationData: null | NotificationData = null

ogMetaData

ogMetaData: null | OGMetaData

parentMessage

parentMessage: null | BaseMessage = null

parentMessageId

parentMessageId: number

reactions

reactions: Reaction[] = []

scheduledInfo

scheduledInfo: null | ScheduledInfo = null

silent

silent: boolean = false

threadInfo

threadInfo: null | ThreadInfo = null

translations

translations: object = {}

updatedAt

updatedAt: number = 0

Methods

applyParentMessage

applyParentMessage(parentMessage): boolean
Parameters
- parentMessage: BaseMessage
Returns boolean

Inherited from BaseMessage.applyParentMessage

applyReactionEvent

applyReactionEvent(reactionEvent): void
Parameters
- reactionEvent: ReactionEvent
Returns void

Inherited from BaseMessage.applyReactionEvent

applyThreadInfoUpdateEvent

applyThreadInfoUpdateEvent(threadInfoUpdateEvent): boolean
Parameters
- threadInfoUpdateEvent: ThreadInfoUpdateEvent
Returns boolean

Inherited from BaseMessage.applyThreadInfoUpdateEvent

getMetaArraysByKeys

getMetaArraysByKeys(keys): MessageMetaArray[]
Parameters
- keys: string[]
Returns MessageMetaArray[]

Inherited from BaseMessage.getMetaArraysByKeys

getThreadedMessagesByTimestamp

getThreadedMessagesByTimestamp(ts, params): Promise<{
parentMessage: BaseMessage;
threadedMessages: BaseMessage[];
}>
Parameters
- ts: number
- params: ThreadedMessageListParams
Returns Promise<{
parentMessage: BaseMessage;
threadedMessages: BaseMessage[];
}>

isAdminMessage

isAdminMessage(): this is AdminMessage
Returns this is AdminMessage

Inherited from BaseMessage.isAdminMessage

isEqual

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

Inherited from BaseMessage.isEqual

isFileMessage

isFileMessage(): this is FileMessage
Returns this is FileMessage

Inherited from BaseMessage.isFileMessage

isIdentical

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

Inherited from BaseMessage.isIdentical

isMultipleFilesMessage

isMultipleFilesMessage(): this is MultipleFilesMessage
Returns this is MultipleFilesMessage

Inherited from BaseMessage.isMultipleFilesMessage

isUserMessage

isUserMessage(): this is UserMessage
Returns this is UserMessage

Inherited from BaseMessage.isUserMessage

serialize

serialize(): object
Returns object

Inherited from BaseMessage.serialize

Class AdminMessage

Hierarchy

Index

Properties

Methods

Properties

appleCriticalAlertOptions

Readonly channelType

Readonly channelUrl

createdAt

customType

data

extendedMessage

isOperatorMessage

mentionType

mentionedMessageTemplate

mentionedUserIds

mentionedUsers

message

messageId

messageType

metaArrays

notificationData

ogMetaData

parentMessage

parentMessageId

reactions

scheduledInfo

silent

threadInfo

translations

updatedAt

Methods

applyParentMessage

Parameters

parentMessage: BaseMessage

Returns boolean

applyReactionEvent

Parameters

reactionEvent: ReactionEvent

Returns void

applyThreadInfoUpdateEvent

Parameters

threadInfoUpdateEvent: ThreadInfoUpdateEvent

Returns boolean

getMetaArraysByKeys

Parameters

keys: string[]

Returns MessageMetaArray[]

getThreadedMessagesByTimestamp

Parameters

ts: number

params: ThreadedMessageListParams

Returns Promise<{ parentMessage: BaseMessage; threadedMessages: BaseMessage[]; }>

isAdminMessage

Returns this is AdminMessage

isEqual

Parameters

message: BaseMessage

Returns boolean

isFileMessage

Returns this is FileMessage

isIdentical

Parameters

message: BaseMessage

Returns boolean

isMultipleFilesMessage

Returns this is MultipleFilesMessage

isUserMessage

Returns this is UserMessage

serialize

Returns object

Settings

Member Visibility

Theme

On This Page

`Readonly` channelType

`Readonly` channelUrl

Returns Promise<{
parentMessage: BaseMessage;
threadedMessages: BaseMessage[];
}>