Class BaseMessage

Hierarchy

default
- 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 = {}

`Optional` extendedMessagePayload

extendedMessagePayload?: Record<string, unknown>

isOperatorMessage

isOperatorMessage: boolean = false

mentionType

mentionType: null | MentionType = null

mentionedMessageTemplate

mentionedMessageTemplate: string

mentionedUserIds

mentionedUserIds: null | string[] = null

mentionedUsers

mentionedUsers: null | User[] = null

messageId

messageId: number

messageType

messageType: MessageType = MessageType.BASE

metaArrays

metaArrays: MessageMetaArray[] = []

ogMetaData

ogMetaData: null | OGMetaData

parentMessage

parentMessage: null | BaseMessage = null

parentMessageId

parentMessageId: number

reactions

reactions: Reaction[] = []

scheduledInfo

scheduledInfo: null | ScheduledInfo = null

silent

silent: boolean = false

suggestedReplies

suggestedReplies: null | string[] = null

threadInfo

threadInfo: null | ThreadInfo = null

updatedAt

updatedAt: number = 0

Methods

applyParentMessage

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

applyReactionEvent

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

applyThreadInfoUpdateEvent

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

getMetaArraysByKeys

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

Inherited from MessagePrototype.getMetaArraysByKeys

isAdminMessage

isAdminMessage(): this is AdminMessage
Returns this is AdminMessage

Inherited from MessagePrototype.isAdminMessage

isEqual

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

Inherited from MessagePrototype.isEqual

isFileMessage

isFileMessage(): this is FileMessage
Returns this is FileMessage

Inherited from MessagePrototype.isFileMessage

isIdentical

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

Overrides MessagePrototype.isIdentical

isMultipleFilesMessage

isMultipleFilesMessage(): this is MultipleFilesMessage
Returns this is MultipleFilesMessage

Inherited from MessagePrototype.isMultipleFilesMessage

isUserMessage

isUserMessage(): this is UserMessage
Returns this is UserMessage

Inherited from MessagePrototype.isUserMessage

serialize

serialize(): object
Returns object

Inherited from MessagePrototype.serialize

submitForm

submitForm(data): Promise<void>
Parameters
- data: {
  answers: Record<string, string>;
  formId: string;
  }
  - answers: Record<string, string>
  - formId: string
Returns Promise<void>

Class BaseMessage

Hierarchy

Index

Properties

Methods

Properties

appleCriticalAlertOptions

Readonly channelType

Readonly channelUrl

createdAt

customType

data

extendedMessage

Optional extendedMessagePayload

isOperatorMessage

mentionType

mentionedMessageTemplate

mentionedUserIds

mentionedUsers

messageId

messageType

metaArrays

ogMetaData

parentMessage

parentMessageId

reactions

scheduledInfo

silent

suggestedReplies

threadInfo

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[]

isAdminMessage

Returns this is AdminMessage

isEqual

Parameters

message: default

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

submitForm

Parameters

data: { answers: Record<string, string>; formId: string; }

answers: Record<string, string>

formId: string

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Readonly` channelType

`Readonly` channelUrl

`Optional` extendedMessagePayload

data: {
answers: Record<string, string>;
formId: string;
}