Class NotificationMessage

Description

Object representing a notification message.

Hierarchy

  • default
    • NotificationMessage

Properties

channelType channelUrl createdAt customType data extendedMessage extendedMessagePayload? mentionedMessageTemplate mentionedUserIds mentionedUsers mentionType messageStatus messageType metaArrays notificationData notificationId priority updatedAt

Methods

getMetaArraysByKeys isAdminMessage isEqual isFileMessage isIdentical isMultipleFilesMessage isUserMessage serialize

Properties

ReadonlychannelType

channelType: ChannelType = ChannelType.BASE

The ChannelType of the channel this message belongs to.

ReadonlychannelUrl

channelUrl: string

The channel URL of the channel this message belongs to.

createdAt

createdAt: number = 0

The creation time of the message in milliseconds.

customType

customType: string

The custom type of the message.

data

data: string

The custom type of the message.

extendedMessage

extendedMessage: object = {}

The template for the message.

OptionalextendedMessagePayload

extendedMessagePayload?: Record<string, unknown>

The datas for the message.

mentionedMessageTemplate

mentionedMessageTemplate: undefined | string = undefined

The mentioned message template of the message.

mentionedUserIds

mentionedUserIds: null | string[] = null

The mentioned user ids of the message.

mentionedUsers

mentionedUsers: null | User[] = null

The mentioned users of the message.

mentionType

mentionType: null | MentionType = null

The mention type. Refer to MentionType.

messageStatus

messageStatus: NotificationMessageStatus

The message status of the notification message. This message status will be changed only if the channel is a FeedChannel.

messageType

messageType: MessageType = MessageType.BASE

metaArrays

metaArrays: MessageMetaArray[] = []

Gets an array of meta arrays sorted by chronological order.

notificationData

notificationData: null | NotificationData = null

Notification data.

ReadonlynotificationId

notificationId: string

The ID of the notification message.

priority

priority: NotificationPriority

Notification priority. This value can be set when the notification message is sent and default value is NotificationPriority.NORMAL.

updatedAt

updatedAt: number = 0

The updated time of the message in milliseconds.

Methods

getMetaArraysByKeys

isAdminMessage

isEqual

  • isEqual(message): boolean

  • Parameters

    • message: MessagePrototype

    Returns boolean

    Description

    Whether the given message is equal in all the values of this message.

isFileMessage

isIdentical

  • isIdentical(message): boolean

  • Parameters

    Returns boolean

    Description

    Whether the given message is identical to this message.

isMultipleFilesMessage

isUserMessage

serialize

  • serialize(): object

  • Returns object

    Description

    Serializes a UserMessage, FileMessage or AdminMessage instance. The instance can be restored by MessageModule.buildMessageFromSerializedData.

Settings

Member Visibility

On This Page

Properties
Methods