Skip to content

Message

A basic message prompt with a button that allows the user to acknowledge and dismiss the message. In Mobile Development Kit, you can create such messages and define their behavior.

All the properties defined under Action are applicable to this action.

Message Properties

Property Type Required
CancelCaption string No
Message string Yes
OKCaption string No
OnCancel ActionOrRule No
OnOK ActionOrRule No
Styles object No
Title string No
_Type const Yes

CancelCaption

Text on the Cancel button to be displayed.

  • type: string

Message

Text in the prompt that conveys the message.

  • type: string

OKCaption

Text on the OK button to be displayed.

  • type: string

OnCancel

Event handler to be triggered when Cancel button is pressed.


OnOK

Event handler to be triggered when OK button is pressed.


Styles

Custom styles to be applied to Message. These styles will override semantic based styling. Supported in Mobile only.

  • type: object with following properties.
Property Type Required Default
Dialog string No
Title string No
Message string No
OKButton string No
CancelButton string No

Dialog

The class name for Message, supports background and text alignment(IOS only) styles to the message.

Title

The class name for Title, supports color and font styles to the title text of the message.

Message

The class name for Message, supports color and font styles to the message text of the message.

OKButton

The class name for OKButton, supports font color to the OK button text of the message.

CancelButton

The class name for CancelButton, supports font color to the Cancel button text of the message.


Title

Title of the message prompt.

  • type: string

_Type

  • type: const

The value of this property must be:

"Action.Type.Message"

Action Result

This action does not have a ActionResult.


Examples

// Message.action
{
   "Message": "This is a message.",
   "OKCaption": "Okay",
   "Title": "Attention!!!",
   "_Type": "Action.Type.Message",
   "Sytles": {
    "Dialog": "dialog-style",
    "Title": "dialog-title-style",
    "Message": "dialog-message-style",
    "OKButton": "ok-button-style",
    "CancelButton": "cancel-button-style"
   }
}

Style Classes Definition

.dialog-style {
  background-color:blue;
  text-align:center; /* IOS Only */
}

.dialog-title-style {
  font-color:grey;
  font-size: 30;
  font-style: italic; /* IOS Only */
  font-name: italic; /* IOS Only */
  font-typeface: italic; /* Android Only */
}

.dialog-message-style {
  font-color:red;
  font-size: 5;
  font-style: normal; /* IOS Only */
  font-name: normal; /* IOS Only */
  font-typeface: normal; /* Android Only */
}

.ok-button-style {
  font-color:yellow;
}

.cancel-button-style {
  font-color:red;
}