Class UserMessage

Description

Object representing a user message.

Hierarchy

  • default
    • UserMessage

Properties

appleCriticalAlertOptions channelType channelUrl createdAt customType data errorCode extendedMessage extendedMessagePayload? isOperatorMessage mentionedMessageTemplate mentionedUserIds mentionedUsers mentionType message messageForm messageId messageParams messageReviewInfo? messageType metaArrays myFeedback myFeedbackStatus ogMetaData parentMessage parentMessageId plugins reactions replyToChannel reqId scheduledInfo sender sendingStatus silent suggestedReplies threadInfo translations translationTargetLanguages updatedAt

Accessors

isResendable poll

Methods

applyParentMessage applyPoll applyReactionEvent applyThreadInfoUpdateEvent deleteFeedback getMetaArraysByKeys getThreadedMessagesByTimestamp isAdminMessage isEqual isFileMessage isIdentical isMultipleFilesMessage isUserMessage markThreadAsRead serialize setPushNotificationEnabled submitFeedback submitMessageForm updateFeedback

Properties

appleCriticalAlertOptions

appleCriticalAlertOptions: null | AppleCriticalAlertOptions = null

The apple critical alert options of the message.

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.

errorCode

errorCode: number = 0

The error code of them message if the sendingStatus is SendingStatus.FAILED.

extendedMessage

extendedMessage: object = {}

The template for the message.

OptionalextendedMessagePayload

extendedMessagePayload?: Record<string, unknown>

The datas for the message.

isOperatorMessage

isOperatorMessage: boolean = false

Whether the message was sent from an operator.

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.

message

message: string

The message text of the message.

messageForm

messageForm: null | MessageForm = null

The form of the message.

messageId

messageId: number

The ID of the message.

messageParams

messageParams: null | UserMessageCreateParams = null

The messageParams object that used for sending this message For more details.

Optional ReadonlymessageReviewInfo

messageReviewInfo?: MessageReviewInfo

The message review history of the message. It only exists when the message was reviewed.

messageType

messageType: MessageType = MessageType.BASE

metaArrays

metaArrays: MessageMetaArray[] = []

Gets an array of meta arrays sorted by chronological order.

myFeedback

myFeedback: null | Feedback = null

My feedback of the message. Not null, if its FeedbackStatus is FeedbackStatus.SUBMITTED Null, if its FeedbackStatus is FeedbackStatus.NOT_APPLICABLE or FeedbackStatus.NO_FEEDBACK/b>.

myFeedbackStatus

myFeedbackStatus: FeedbackStatus = 'NOT_APPLICABLE'

My feedback status of the message.

ogMetaData

ogMetaData: null | OGMetaData

The OGMetaData of the message. Might be null if

parentMessage

parentMessage: null | BaseMessage = null

The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message.

parentMessageId

parentMessageId: number

The parent message's ID if this is a reply message.

Readonlyplugins

plugins: Plugin[] = []

The plugin lists for this message.

reactions

reactions: Reaction[] = []

The reactions on the message.

replyToChannel

replyToChannel: boolean = false

Determines whether the current message is a replied message and also a message was replied to the channel.

reqId

reqId: string = ''

scheduledInfo

scheduledInfo: null | ScheduledInfo = null

The scheduled info of the message if this is a scheduled message

Readonlysender

sender: Sender

Sender of the message. This is represented by Sender class.

sendingStatus

sendingStatus: SendingStatus

The sending status of the message.

silent

silent: boolean = false

Checks whether the message is silent or not.

suggestedReplies

suggestedReplies: null | string[] = null

The suggested replies of the message.

threadInfo

threadInfo: null | ThreadInfo = null

The thread info of the message.

Readonlytranslations

translations: object = {}

The translated messages (key-value map) for the language codes in key.

ReadonlytranslationTargetLanguages

translationTargetLanguages: string[] = []

The list of target translation languages with the language codes. The messages that have been sent or scheduled with translation option (refer to BaseChannel.sendUserMessage) will have this list.

updatedAt

updatedAt: number = 0

The updated time of the message in milliseconds.

Accessors

isResendable

  • get isResendable(): boolean

  • Whether the message is resendable. Used only if the message is failed/canceled to send.

    Returns boolean

poll

  • get poll(): null | Poll

  • The poll that belongs to this message object.

    Returns null | Poll

Methods

applyParentMessage

  • applyParentMessage(parentMessage): boolean

  • Parameters

    Returns boolean

    Description

    When parent message is updated, you can update the child message's parent message through this method. If you use MessageCollection, messages in the collection are automatically updated, so don't need to call it.

applyPoll

  • applyPoll(poll): boolean

  • Parameters

    Returns boolean

    Description

    When you get updated polls from groupChannel.getPollChangeLogsSinceToken() or groupChannel.getPollChangeLogsSinceTimestamp(), you can update the user message's poll through this function. If you use MessageCollection, messages in the collection are automatically updated, so don't need to call it.

applyReactionEvent

  • applyReactionEvent(reactionEvent): void

  • Parameters

    Returns void

    Description

    Applies ReactionEvent to message.

applyThreadInfoUpdateEvent

  • applyThreadInfoUpdateEvent(threadInfoUpdateEvent): boolean

  • Parameters

    Returns boolean

    Description

    Applies ThreadInfoUpdateEvent to a message.

deleteFeedback

  • deleteFeedback(feedbackId): Promise<void>

  • Parameters

    • feedbackId: number

    Returns Promise<void>

    Description

    Deletes the feedback for the message. The feedback can be deleted only when the FeedbackStatus is FeedbackStatus.SUBMITTED.

getMetaArraysByKeys

getThreadedMessagesByTimestamp

  • getThreadedMessagesByTimestamp(ts, params): Promise<{
        parentMessage: BaseMessage;
        threadedMessages: BaseMessage[];
    }>

  • Parameters

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

    Description

    Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesn’t have replies, the result is an empty list.

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

    • message: SendableMessage

    Returns boolean

isMultipleFilesMessage

isUserMessage

markThreadAsRead

  • markThreadAsRead(): Promise<void>

  • Returns Promise<void>

    Description

    Marks the message thread as read.

serialize

setPushNotificationEnabled

  • setPushNotificationEnabled(pushEnabled): Promise<void>

  • Parameters

    • pushEnabled: boolean

    Returns Promise<void>

    Description

    Sets push notification enabled for the thread.

submitFeedback

  • submitFeedback(data): Promise<void>

  • Parameters

    • data: Pick<Feedback, "rating" | "comment">

    Returns Promise<void>

    Description

    Submits the feedback for the message. The feedback can be submitted only when the FeedbackStatus is FeedbackStatus.NO_FEEDBACK.

submitMessageForm

  • submitMessageForm(): Promise<void>

  • Returns Promise<void>

    Description

    Submits the message form of this message.

  • submitMessageForm(data): Promise<void>

  • Parameters

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

    Returns Promise<void>

    Deprecated

    since v4.13.0. Use submitMessageForm() instead.

updateFeedback

  • updateFeedback(data): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Updates the feedback for the message. The feedback can be updated only when the FeedbackStatus is FeedbackStatus.SUBMITTED.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods