Success Toast Message

Owned by kiran.kumari@intellectdesign.com (Unlicensed)
Last updated: Jul 22, 2019 by Ravikumar Babu CTOO (Unlicensed)

canvas.toastMessageManager.showSuccessToastMessage is the predefined API method to show the success Toast message to the user.
The developer can configure the following parameters for this API:

API Parameter

Description

Sample Value

toastHeader

Indicates the header text for the toast message.
The maximum character limit for this parameter is 30. The characters exceeding this limit will not be displayed and only an eclipse (...) will be rendered.

Funds Transfer

toastMessage

Indicates the message that is to be displayed within the toast message.
The maximum character limit for this parameter is 40. The characters exceeding this limit will not be displayed and only an eclipse (...) will be rendered.

Transaction Successful.

hideAfterTimer

Indicates the time duration for the toast message. The value for this parameter must be provided in milli-seconds.
The default value for this parameter is '3000'.

3000

beforeShow

Indicates the event that can be triggered right before the toast is about to appear.
The default value for this parameter is null.

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.
The default value for this parameter is null.

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:

  • true: Enables the loader (load mask) for the toast message.

  • false: Does not enable the loader.

    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.showSuccessToastMessage("Funds Transfer", "Transaction Successful.", 3000)



Figure 3: Success Toast Message - Mobile



Figure 4: Success Toast Message - Desktop