- closeModal()
This function sends to IO App the input to stop the webview communication and close the current screen.
- showLoader()
This function sends to IO App the input to show the activity indicator loader.
- hideLoader()
This function sends to IO App the input to hide the activity indicator loader.
- showSuccess(payload)
A function to show the success component on the IO App side.
- showErrorMessage(payload)
A function to send an error message to IO App component
- showAlertBox(payload)
A function to show an AlertBox in the IO App component.
- checkInjectionCompleted()
This is a utility function to check if the injection is yet completed. This calls onInjectionCompleted function which is implemented by the client and not injected by IO App.
- AlertContents :
Object An Object to define the values of Title and description of an alert box.
- MessagePayloadS :
Object An object defined for internationalization purpose. The key is the language key and the value is the message text
Accepted keys:
- it
- en
- MessagePayloadL :
Object An object defined for internationalization purpose. The key is the language key and the value is the payload for alert box
This function sends to IO App the input to stop the webview communication and close the current screen.
This function sends to IO App the input to show the activity indicator loader.
This function sends to IO App the input to hide the activity indicator loader.
A function to show the success component on the IO App side.
Kind: global function
| Param | Type | Description |
|---|---|---|
| payload | MessagePayloadS |
Will be the message showed in the success screen, otherwise a common text will be displayed |
A function to send an error message to IO App component
Kind: global function
| Param | Type |
|---|---|
| payload | MessagePayloadS |
A function to show an AlertBox in the IO App component.
Kind: global function
| Param | Type | Description |
|---|---|---|
| payload | MessagePayloadL |
the value to display in the alert box. |
This is a utility function to check if the injection is yet completed. This calls onInjectionCompleted function which is implemented by the client and not injected by IO App.
An Object to define the values of Title and description of an alert box.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| title | string |
The title of the alert box. |
| description | string |
The main message of the alert box. |
An object defined for internationalization purpose. The key is the language key and the value is the message text
Accepted keys:
- it
- en
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| it | string |
The message defined in Italian. |
| en | string |
The message defined in English. |
An object defined for internationalization purpose. The key is the language key and the value is the payload for alert box
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| it | AlertContent |
The values of the alert box in Italian language |
| en | AlertContent |
The values of the alert box in English language |