Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.0

API: Message.GetTextForMessage

Scoped Name

APIServer.Messages.GetTextForMessage

Interface

Field Variable ...as Description
MessageID Input Input The unique identification of the message.
Language Code Language Input The language you want to retrieve the text for.

Leave the language code and site key blank to retrieve the base text.

SiteKey Language Input The unique identification of the site the language (and the translation of the base text) is specified for.

Leave the language code and site key blank to retrieve the base text.

MessageText Output Output The translated text for the message

Description

Retrieves the translated text of a message.

If you do not specify a Language/Site combination, or the Language/Site combination does not exist or there are no translation for the message text of the message type for the Language/Site combination, the base text for the message will be returned. This is the text that will be shown in the log to a user that has the specified language for the selected site.

In addition to finding the translated text, the replacement based on the parameters that was specified when the message was written to the log will also be performed.

Events

Universal events