Interface MessageHistory

This interface contains information about the history of a given message. This information will eventually be saved in the history store.

interface MessageHistory {
    is_welcome_request?: boolean;
    label?: string;
    relatedMessageID?: string;
    timestamp?: number;
    user_defined?: unknown;
}

Properties

is_welcome_request? label? relatedMessageID? timestamp? user_defined?

Properties

Optionalis_welcome_request

is_welcome_request?: boolean

If the message was a welcome node request.

Optionallabel

label?: string

The user-friendly label that was associated with this message. This is used on messages that were sent by the user to the assistant to request a response. This is the user displayed text that was entered or selected by the user when that request was made.

OptionalrelatedMessageID

relatedMessageID?: string

If this message is related to another message, this is the ID of that other message. This is used when a user choices an option and it includes the ID of the message response that presented the options to the user so we can associate the user's request with that earlier response and display the appropriate selected state.

Optionaltimestamp

timestamp?: number

The time at which this message occurred.

Optionaluser_defined

user_defined?: unknown

For session history the data passed to instance.updateHistoryUserDefined() is returned to the user here (on page change/refresh).

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR