Skip to content

Function

The Toast API contains the following function.

voltmx.ui.Toast


Creates a Toast object.

Important: The voltmx.ui.Toast function is only available for the Android platform.

Syntax


voltmx.ui.Toast(configParams)

Input Parameters

Parameter Description
configParams A JavaScript object that contains key-value pairs that provide the configuration of the toast to be created. The following keys are supported. text: The text for the toast to display. duration: The duration of time that the toast appears on the screen. This must be set to one of the Toast Duration Constants.

Example


var toast = new voltmx.ui.Toast({
  "text": "This is the toast's text.",
  "duration": constants.SHORT
  });
toast.show();

Return Values

Returns an instantiated Toast Object.

Platform Availability

  • Android