Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor_Toc523144958_Toc523144958 Anchor_GoBack_GoBackError Toast Message
ctcanvas.toastMessageManager.showErrorToastMessage is the predefined API method to show the error Toast message to the user.
The developer can configure the followingparameters 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 Failed.

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.


Code Block
languagejs
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.


Code Block
languagejs
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.


    Info
Note:
  • The load mask for the toast message indicates the time duration of the toast message.


true


Info

...

If no values are provided for the API parameters mentioned in the above table, then the default values will be considered for execution.

Example:
ct

Code Block
languagejs
canvas.toastMessageManager.showErrorToastMessage("Funds Transfer", "Transaction Failed.", 3000) 


Image Modified
Figure 5: Error Toast Message - Mobile

...



Image Modified

Figure 6: Error Toast Message - Desktop