Argument | Description | Types / Required |
number | The message number. | number
required |
type | The message set to query.
The default value is "user". | string
not required |
text | Default text for this message (if not found in a message set). | string
not required |
The
Message.getText action returns the base (unformatted) text for a message defined in a
message file. By default, the message text is retrieved from user-defined messages, but by specifying the
type as
"system" (as opposed to
"user"), message text from
system messages is returned.
The action returns a string containing the message text, or the default text if no message with the number exists. The message text is returned in the
current language, if applicable.
The action throws an exception if any of its arguments are not specified in a valid form, or if the message number does not exist in the specified message set and no default message text is provided.
const partialSaveMessage = CS.Message.getText({
number: 89222,
type: "system"
});