Information Toast Message
canvas.toastMessageManager.showInfoToastMessage is the predefined API method to show an Information Toast message to the user.
The developer can configure the following parameters of this API:
API Parameter | Description | Sample Value |
---|---|---|
toastHeader | Indicates the header text for the toast message. | KYC |
toastMessage | Indicates the message that is to be displayed within the toast message. | Please register your PAN details. |
hideAfterTimer | Indicates the time duration for the toast message. The value for this parameter must be provided in milli-seconds. | 4000 |
beforeShow | Indicates the event that can be triggered right before the toast is about to appear. | config.beforeShow=function() { launchObjects_create_tickets = { "formId" : "FORM_DEF1", "renderType" : 'WINDOW' } canvas.launch(launchObjects_create_tickets); } |
afterShown | Indicates the event that can be triggered after the toast appears. | config.afterShown=function() { launchObjects_create_tickets = { "formId" : "FORM_DEF1", "renderType" : 'WINDOW' } canvas.launch(launchObjects_create_tickets); } |
isShowLoader | Indicates whether the toast message will be displayed with a load mask or not. This parameter can have the following values:
The load mask for the toast message indicates the time duration of the toast message. | true |
If no values are provided for the API parameters mentioned in the above table, then the default values will be considered for execution.
Example:
canvas.toastMessageManager.showInfoToastMessage("KYC", "Please register your PAN details.", 4000)
Figure 1: Information Toast Message - Mobile
Figure 2: Information Toast Message - Desktop