Skip to content


The Toast API contains the following function.


Creates a Toast object.

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



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.


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

Return Values

Returns an instantiated Toast Object.

Platform Availability

  • Android