Class: Popup

new Popup_A()

Source: as-popup.js, line 3

Members

(static) CANCEL :string

'cancel'

Type:

string

Source: as-popup.js, line 79

(static) OK :string

'ok'

Type:

string

Source: as-popup.js, line 68

(static) cancel

'cancel'

Deprecated: Uses TComponents.Popup_A.CANCEL
Source: as-popup.js, line 57

(static) ok

'ok'

Deprecated: Uses TComponents.Popup_A.OK
Source: as-popup.js, line 46

enabled

Source: as-popup.js, line 31

show

Source: as-popup.js, line 19

Methods

confirm(msg1, msg_arrayopt, callbackopt)

A popup dialog is a modal window that provides "OK/Cancel" confirmation dialog.

Parameters:

Name	Type	Attributes	Description
`msg1`	string		A string, describing the topic of the message.
`msg_array`	string \| Array.<string>	<optional>	The actual message. It can be either a simple string or, if several lines are required, an array where each element is a string with a message line.
`callback`	function	<optional>	A function that will be called when the user dismisses by pressing the 'OK' or 'Cancel' button.

Source: as-popup.js, line 291

Example

TComponents.Popup_A.confirm(
  `XXX module not yet loaded on the controller`,
  ['This module is required for this WebApp.', 'Do you want to load the module?'],
  (action) => {
   if (action === 'ok') {
     console.log("Load the module here...")
   } else if (action == 'cancel') {
     console.log("Abort mission!");
   }
 }
);

danger(msg1, msg_arrayopt, callbackopt)

A popup dialog is a modal window that provides the user with danger messages.

Parameters:

Name	Type	Attributes	Description
`msg1`	string		A string, describing the topic of the message.
`msg_array`	string \| Array.<string>	<optional>	The actual message. It can be either a simple string or, if several lines are required, an array where each element is a string with a message line.
`callback`	function	<optional>	A function that will be called when the user dismisses by pressing the 'OK' or 'Cancel' button.

Source: as-popup.js, line 176

Example

try {
   // do something
 } catch (e) {
   TComponents.Popup_A.danger('Something went wrong', [e.message, e.description]);
 }

error(e)

A popup dialog is a modal window that provides the user with error messages.

Parameters:

Name	Type	Description
`e`	object	Error object for example, errorthrown by Omnicore RWS

Source: as-popup.js, line 204
See: Omnicore-App-SDK
To Do: Optimize the parsing of error object

Example

try {
   throw new Error("Whoops!");
 } catch (e) {
   TComponents.Popup_A.error(e, 'Custom title');
 };

info(msg1, msg_arrayopt, callbackopt)

A popup dialog is a modal window that provides the user with information messages. The main difference from the Popup_A.message is that Popup_A.info includes an "i" image in the modal window.

Parameters:

Name	Type	Attributes	Description
`msg1`	string		A string, describing the topic of the message.
`msg_array`	string \| Array.<string>	<optional>	The actual message. It can be either a simple string or, if several lines are required, an array where each element is a string with a message line.
`callback`	function	<optional>	A function that will be called when the user dismisses by pressing the 'OK' or 'Cancel' button.

Source: as-popup.js, line 130

Example

TComponents.Popup_A.info(
  "Important information!",
  [
    "For your information, this is a popup dialog.",
    "",
    "Further information can be given here!"
  ],
 function (action) {
   console.log("OK button was clicked")
 });

message(msg1, msg_arrayopt, callbackopt)

A popup dialog is a modal window that provides the user with information messages.

Parameters:

Name	Type	Attributes	Description
`msg1`	string		A string, describing the topic of the message.
`msg_array`	string \| Array.<string>	<optional>	The actual message. It can be either a simple string or, if several lines are required, an array where each element is a string with a message line.
`callback`	function	<optional>	A function that will be called when the user dismisses by pressing the 'OK' or 'Cancel' button.

Source: as-popup.js, line 103

Example

TComponents.Popup_A.message(
  "Important message!",
  [
    "For your information, this is a popup dialog.",
    "",
    "Further information can be given here!"
  ],
 function (action) {
   console.log("OK button was clicked")
 });

warning(msg1, msg_arrayopt, callbackopt)

A popup dialog is a modal window that provides the user with warning messages.

Parameters:

Name	Type	Attributes	Description
`msg1`	string		A string, describing the topic of the message.
`msg_array`	string \| Array.<string>	<optional>	The actual message. It can be either a simple string or, if several lines are required, an array where each element is a string with a message line.
`callback`	function	<optional>	A function that will be called when the user dismisses by pressing the 'OK' or 'Cancel' button.

Source: as-popup.js, line 153

Example

try {
   // do something
 } catch (e) {
   Popup_A.waring('Something went wrong', [e.message, e.description]);
 }