A structured message object. Used to return errors from requests.

Fields

@:optionaloptionalvariables:Null<DynamicAccess<String>>

An object used as a dictionary for looking up the variables in the format string.

@:optionaloptionalurlLabel:Null<String>

An optional label that is presented to the user as the UI for opening the url.

@:optionaloptionalurl:Null<String>

An optional url where additional information about this message can be found.

@:optionaloptionalshowUser:Null<Bool>

If true show user.

@:optionaloptionalsendTelemetry:Null<Bool>

If true send to telemetry.

id:Int

Unique identifier for the message.

format:String

A format string for the message. Embedded variables have the form '{name}'. If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.