Class: WebappMessage

sync.api. WebappMessage


new WebappMessage()

A custom message sent by the server-side code.

Members


<static> CUSTOM_MESSAGE :number

The type of a Webapp custom message.
Type:
  • number

<static> SYSTEM_APPLICATION_MESSAGE :number

The type of open in system application webapp message.
Type:
  • number

message :string

The actual content of the message - you can use this to send information about the message to be displayed to the user.
Type:
  • string

title :string

The title of the message: usually displayed in the header of the notification pop-up.
Type:
  • string

type :number

The type of the message set by the server-side code.
Type:
  • number

url :string

The url of the resource for which the message was generated (available only for messages generated for UserActionRequiredEvents).
Type:
  • string

userGenerated :boolean

true if the message was generated by some user action, as opposed an error regarding framework's consistency: e.g. parsing error in the CSS. Error messages with this flag set to false should not be displayed visibly to the user, but in the browser's console instead.
Type:
  • boolean