Skip to content

BannerMessage

The banner message is like a self-dismissing toast that is attached to the app's main navigation bar. It is more geared towards alerting the user of error conditions.

The properties defined in Action are also applicable to this action.

BannerMessage Properties

Property Type Required Default
ActionLabel string Optional
Animated boolean Optional true
DismissBannerOnAction boolean Optional false
Duration integer Optional 2
Message string Required
OnActionLabelPress ActionOrRule Optional
_Type const Required

ActionLabel

Label to indicate that banner is clickable. On Android, it will be used as button label. On iOS, it will be appended to Message.

  • type: string

Animated

Whether Banner showing is animated. Not supported in Android. The Banner for Android will always gets animated.

  • type: boolean
  • default: true

DismissBannerOnAction

Whether to dismiss banner when banner is clicked to perform another action.

  • type: boolean
  • default: false

Duration

Number of seconds to display Banner. Set to 0 to display it indefinitely, it can be closed by pressing the 'DISMISS' button on Android / close icon on iOS.

  • type: integer
  • default: 2

Message

Message to show. If it's too long, it will wrap.

  • type: string

OnActionLabelPress

Action/Rule to be triggered when ActionLabel is pressed. This is applicable only when both ActionLabel and OnActionLabelPress are non-empty.


_Type

  • type: const

The value of this property must be equal to:

"Action.Type.BannerMessage"

Action Result

This action has no ActionResult.


Examples

// BannerMessage.action
{
    "Message": "Message in a banner.",
    "Duration": 15,
    "Animated": true,
    "ActionLabel": "$(PLT,'Click to retry.','Retry')",
    "OnActionLabelPress": "/path/to/ConfirmMessage.action",
    "DismissBannerOnAction": true,
    "_Type": "Action.Type.BannerMessage"
}