Utility Methods

info

Utility methods which do not return any value work only on preview screen

UTILITY is a Javascript API provided by DronaHQ to perform various actions directly from your javascript code. It enables you to use actions which are present in actionflow builder directly from the code giving you more control on the behaviour of your application.

TOAST

UTILITY.TOAST() method can be used to show toast messages.

Usage

UTILITY.TOAST(type,title,message,position,closeButton,timeout);

Parameters

Parameter	Accepts	Possible values
type	string	'info', 'error', 'success', 'warning'
title	string	any string value
message	string	any string value
position	string	'toast-top-right','toast-top-left', 'toast-top-center', 'toast-bottom-right' , 'toast-bottom-left', 'toast-bottom-center', 'toast-top-full-width, 'toast-bottom-full-width'
closeButton	boolean	true/false
timeout	Number	any positive numerical value (in milliseconds)

Example

UTILITY.TOAST('success','Toast says','Hello','toast-top-right',true,5000);

CONFIRM

UTILITY.CONFIRM() method can be used to show a prompt message to the user and get input such as ok and cancel. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.CONFIRM(title,message,confirmButtonText,cancelButtonText);

Parameters

Parameter	Accepts	Possible values
title	string	any string value
message	string	any string value
confirmButtonText	string	any string value
cancelButtonText	string	any string value

Example

await UTILITY.CONFIRM('Confirm says','Confirm this message','OK','Cancel');

User Input

When the Promise resolves, the user input will be received in the action key inside a javascript object:

{
  action: 'OK'
}

ALERT

UTILITY.ALERT() method can be used to show a alert message to the user. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.ALERT(type,title,message,confirmButtonText);

Parameters

Parameter	Accepts	Possible values
type	string	'info', 'error', 'success'
title	string	any string value
message	string	any string value
confirmButtonText	string	any string value

Example

await UTILITY.ALERT('success','Alert says','Hello','Ok');

User Input

When the Promise resolves, the user input will be received as a boolean value:

true

EMAIL

UTILITY.EMAIL() method can be used to send emails.

Usage

UTILITY.EMAIL(subject,body,recipients);

Parameters

Parameter	Accepts	Possible values
subject	string	any string value
body	string	any string value
recipients	string	string of email ids (Comma separated)

Example

UTILITY.EMAIL('This is subject','Hello','user1@mail.com,user2@mail.com');

CALL

UTILITY.CALL() method can be used to make calls.

Usage

UTILITY.CALL(phoneNumber);

Parameters

Parameter	Accepts	Possible values
phoneNumber	Number	any numerical value

Example

UTILITY.CALL(9699194532);

SMS

UTILITY.SMS() method can be used to send sms.

Usage

UTILITY.SMS(phoneNumbers,message);

Parameters

Parameter	Accepts	Possible values
phoneNumbers	string	string of phone numbers (comma separated)
message	string	any string value

Example

UTILITY.SMS('9699194532,9619723541','Hello');

CALLRESTAPI

UTILITY.CALLRESTAPI() method can be used to communicate with api servers using various HTTP methods like GET, POST, PUT, PATCH, and DELETE. This method returns a promise and to get the response use await keyword.

Usage

UTILITY.CALLRESTAPI(url, method, headers, data, useProxy, timeout);

Parameters

Parameter	Accepts	Possible values
url	string	endpoint url to send the request
method	string	'GET', 'POST', 'PUT', 'PATCH', 'DELETE'
headers	object	json data to send in request headers
data	object	json data to send in request body
useProxy	boolean	true/false to use proxy
timeout	number	any numerical value in milliseconds

Example GET Request

await UTILITY.CALLRESTAPI('https://exampleapi.com/api/users/','GET');

info

headers, data, useProxy and timeout are optional parameters, in case you don't want to specify any of them, put an empty string ('') instead while calling the method.

Example POST Request

await UTILITY.CALLRESTAPI(
  'https://exampleapi.com/api/users/',
  'POST',
  '',
  {'name':'morpheus','job':'leader'}
);

SETCTRLVALUE

UTILITY.SETCTRLVALUE() method can be used to set the value of a control. The method takes an array of objects as input and each object has two keys called name and value. The name key takes control's unique name which can be found in the right side properties panel on the builder screen.

Usage

UTILITY.SETCTRLVALUE(
  [
    {name: 'controlUniqueName' , value: 'Yourvalue'},
    {name: 'anothercontrolUniqueName' , value: 'Yourvalue'}
  ]
);

Object Parameters

Parameter	Accepts	Possible values
name	string	Control's unique name
value	string or object	any string value for single value controls and object for composite controls
selected_value	string or array	any string value or array of strings for list type controls

Example for single value controls

UTILITY.SETCTRLVALUE(
  [
    {name:'textinput',value:'DronaHQ'}
  ]
);

Example for composite controls

UTILITY.SETCTRLVALUE(
  [
    {
      name:'address',
      value: { 
          address1: "test",
          address2: "abc",
          city: "mumbai",
          country: "india",
          state: "mh",
          zip: "66666666666"
        }  
    }
  ]
);

Example for list controls

let dd_data = [
  {
    "name": "test1",
    "value": "test1"
  },
  {
    "name": "test",
    "value": "test"
  }
]
UTILITY.SETCTRLVALUE([
  {
    name: "advanceddropdown",
    value: dd_data,
    selected_value: "test"
  }
])

HIDECTRL

UTILITY.HIDECTRL() method can be used to trigger hide action on a visible control. The method takes an array of strings which contains unique names of the controls.

Usage

UTILITY.HIDECTRL(controlUniqueNameArray);

Parameters

Parameter	Accepts	Possible values
controlUniqueNameArray	array	array of strings (control unique names)

Example

UTILITY.HIDECTRL(['textinput','textinput1']);

SHOWCTRL

UTILITY.SHOWCTRL() method can be used to trigger show action on a hidden control. The method takes an array of strings which contains unique names of the controls.

Usage

UTILITY.SHOWCTRL(controlUniqueNameArray);

Parameters

Parameter	Accepts	Possible values
controlUniqueNameArray	array	array of strings (control unique names)

Example

UTILITY.SHOWCTRL(['textinput','textinput1']);

SETVARIABLE

UTILITY.SETVARIABLE() method can be used to overwrite the value returned by a Custom Javascript code. The method takes an array of objects as input and returns a promise. Each object has two keys called name and value. The name key takes variable name and value takes any string value which needs to be set.

Usage

 UTILITY.SETVARIABLE([{name: 'variableUniqueName' , value: 'Yourvalue'}]);

Parameters

Parameter	Accepts	Possible values
name	string	variable name
value	string	any string value for single value controls and object for composite

Example

await UTILITY.SETVARIABLE([{name: 'js_script_1' , value: 'value1'},{name: 'js_script_2' , value: 'value2'}]);

NAVIGATE

UTILITY.NAVIGATE() method can be used to navigate from one screen to another screen.

Usage

UTILITY.NAVIGATE(screenId,transition,resetTargetPage,withValidation);

Parameters

Parameter	Accepts	Possible values
screenId	string	'Screen Id' present in properties panel on the builder
transition	string	0 or 1 in string value
resetTargetPage	boolean	true/false
withValidation	boolean	true/false

Example

UTILITY.NAVIGATE('screen-2','1',false,false);

CONFETTI

UTILITY.CONFETTI() method can be used to trigger confetti action.

Usage

UTILITY.CONFETTI(spread,particleCount,originX,originY);

Parameters

Parameter	Accepts	Possible values
spread	number	any number to define confetti spread over the page
particleCount	number	number of particles in confetti
originX	number	value in the range 0-1 for position on x-axis
originY	number	value in the range 0-1 for position on y-axis

Example

UTILITY.CONFETTI(70,400,0.5,0.5);

SHOWCTRLLOADER

UTILITY.SHOWCTRLLOADER() method can be used to show a loader on a particular control.

Usage

UTILITY.SHOWCTRLLOADER(controlUniqueNameArray);

Parameters

Parameter	Accepts	Possible values
controlUniqueNameArray	array	array of strings (control unique names)

Example

UTILITY.SHOWCTRLLOADER(['dashboard','dashboard1']);

HIDECTRLLOADER

UTILITY.HIDECTRLLOADER() method can be used to hide the loader which is running on particular control.

Usage

UTILITY.HIDECTRLLOADER(controlUniqueNameArray);

Parameters

Parameter	Accepts	Possible values
controlUniqueNameArray	array	array of strings (control unique names)

Example

UTILITY.HIDECTRLLOADER(['dashboard','dashboard1']);

EXITAPP

UTILITY.EXITAPP() method can be used to trigger exit app action.

Usage

UTILITY.EXITAPP();

LOGOUT

UTILITY.LOGOUT() method can be used to trigger logout action.

Usage

UTILITY.LOGOUT();

REFRESHCTRLDATA

UTILITY.REFRESHCTRLDATA() method can be used to reset the value of a control. The method takes an array of strings as input which have unique names of the controls that need to be reset.

Usage

UTILITY.REFRESHCTRLDATA(ctrlUniqueNames, triggerDependentDataQuery, tableGridPagination);

Parameters

Parameter	Accepts	Possible values
ctrlUniqueNames	array	array of strings (control unique names)
triggerDependentDataQuery	boolean	true/false
tableGridPagination	boolean	true/false

Example

UTILITY.REFRESHCTRLDATA(['textinput','textinput1'],false,false);

INVOKEACTIONFLOW

UTILITY.INVOKEACTIONFLOW() method can be used to invoke an actionflow which set on any event of a control. The value for the event_name parameter is visible in the heading part of the actionflow builder screen.

Usage

UTILITY.INVOKEACTIONFLOW('controlUniqueName','event_name');

Parameters

Parameter	Accepts	Possible values
controlUniqueName	string	control's unique name in string format
event_name	string	control's event name in string format

Example

UTILITY.INVOKEACTIONFLOW('button','button_click');

COPYTOCLIPBOARD

UTILITY.COPYTOCLIPBOARD() method can be used to trigger the copy to clipboard action.

Usage

UTILITY.COPYTOCLIPBOARD(text); 

Parameters

Parameter	Accepts	Possible values
text	string	any string value

Example

UTILITY.COPYTOCLIPBOARD('DronaHQ'); 

OPENURL

UTILITY.OPENURL() method can be used to open a url in a new tab.

Usage

UTILITY.OPENURL(url);

Parameters

Parameter	Accepts	Possible values
url	string	any string value

info

Please make sure that the url entered should always start with "https://"

Example

UTILITY.OPENURL('https://www.google.com/');

PLAYSOUND

UTILITY.PLAYSOUND() method can be used to play any mp3 file by passing url.

Usage

UTILITY.PLAYSOUND(url);

Parameters

Parameter	Accepts	Possible values
url	string	any string value

Example

UTILITY.PLAYSOUND('https://dronamobilepublic.s3.amazonaws.com/DRONA5_Team19020/content/app/images/Qg7Zwtep6a.mp3');

NAVIGATETOAUTHSCREEN

UTILITY.NAVIGATETOAUTHSCREEN() method can be used to trigger the Navigate to Authentication Screen action.

Usage

UTILITY.NAVIGATETOAUTHSCREEN(maintainCredentials,resetLogin);

Parameters

Parameter	Accepts	Possible values
maintainCredentials	boolean	true/false
resetLogin	boolean	true/false

Example

UTILITY.NAVIGATETOAUTHSCREEN(false,false);

MICROAPPNAV

UTILITY.MICROAPPNAV() method can be used to trigger the MicroApp Navigation action. It is also possible to pass key value pairs to the app we wish to navigate to in the form of an array of objects. The appId can be obtained from the actionflow builder in Microapp nav action.

Usage

UTILITY.MICROAPPNAV('appId',[{queryKey: 'yourkey', queryValue: 'yourvalue'}]);

Parameters

Parameter	Accepts	Possible values
appId	string	numerical appId in string form
keyValueArray	array	array of objects containing key value pairs

Example

UTILITY.MICROAPPNAV('4139',[{queryKey: 'key1', queryValue: 'value1'}]);

SETLOCALSTORAGE

UTILITY.SETLOCALSTORAGE() method can be used to store key value pairs locally. This method returns a Promise, so make sure to use the await keyword to successfully complete the operation.

Usage

UTILITY.SETLOCALSTORAGE(key, value);

Parameters

Parameter	Accepts	Possible values
key	string	any string value
value	string	any string value

Example

UTILITY.SETLOCALSTORAGE('dronahq', {Name:John,Age:25})

GETLOCALSTORAGE

UTILITY.GETLOCALSTORAGE() method can be used to retrieved the locally stored value using its unique key. This method returns a Promise, so make sure to use the await keyword to successfully complete the operation.

Usage

UTILITY.GETLOCALSTORAGE(key);

Parameters

Parameter	Accepts	Possible values
key	string	any string value

Example

UTILITY.GETLOCALSTORAGE('dronahq');

CLEARLOCALSTORAGE

UTILITY.CLEARLOCALSTORAGE() method can be used to remove the locally stored key value pairs. This method returns a Promise, so make sure to use the await keyword to successfully complete the operation.

Usage

UTILITY.CLEARLOCALSTORAGE(key)

Parameters

Parameter	Accepts	Possible values
key	string	any string value

Example

UTILITY.CLEARLOCALSTORAGE(key)

Here’s your formatted documentation for SETPROPERTY:

SETPROPERTY

The UTILITY.SETPROPERTY() method allows you to dynamically set properties like read_only and required on input elements, controlling user interaction and validation.

Usage

UTILITY.SETPROPERTY([
   { ctrlName: "controlUniqueName", property: "property_name" },
   { ctrlName: "anotherControlUniqueName", property: "property_name" }
]);

Parameters

Parameter	Accepts	Possible Values
ctrlName	string	Unique name of the control where the property is set.
property	string	Property name to set. Possible values: "read_only", "required".

Example

UTILITY.SETPROPERTY([
   { ctrlName: "textinput1", property: "read_only" },
   { ctrlName: "textinput2", property: "required" }
]);

REMOVEPROPERTY

UTILITY.REMOVEPROPERTY() method can be used to dynamically remove specific properties from input controls. The method takes an object, where the object specifies the control name and the property to be removed.

Usage

UTILITY.REMOVEPROPERTY([{ ctrlName: "controlName", property: "propertyName" }]);

Parameters

Parameter	Accepts	Possible Values
ctrlName	string	Unique name of the control where the property is to be removed.
property	string	Property name to remove. Possible values are: "read_only" (to make the control editable) or "required" (to make it optional).

Example

UTILITY.REMOVEPROPERTY([
   { ctrlName: "textinput1", property: "read_only" }
]);

REDIRECTPARENTUTILITY

The UTILITY.REDIRECTPARENTUTILITY() method allows you to redirect the parent of an iframe to a specified URL. This is useful when your micro-app is embedded within a parent website, enabling controlled navigation to an external destination.

Usage

UTILITY.REDIRECTPARENTUTILITY("URL");

Parameters

Parameter	Accepts	Description
URL	string	The destination URL to which the parent window should be redirected.

Example

UTILITY.REDIRECTPARENTUTILITY("https://docs.dronahq.com/reference/keywords-js-utilities/Utility/#setctrlvalue");

DownloadFileFromURL

The UTILITY.DownloadFileFromURL() method allows users to dynamically download files directly to their devices. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.DownloadFileFromURL(downloadUrl,fileName,headers,pathOfAndroid,pathOfIos,[{ queryKey: "keyName", queryValue: "key_value" },{ queryKey: "anotherKeyName", queryValue: "key_value" }]);

Parameters

Parameter	Accepts	Possible values
downloadUrl	string	A valid HTTP or HTTPS URL pointing to the downloadable file.
fileName	string	A valid file name with extension.
headers	string	JSON object of Headers
pathOfAndroid	string	'application_directory', 'document_directory', 'cache_directory'
pathOfIos	string	'application_directory', 'document_directory', 'cache_directory'
queryKey	string	Alphanumeric strings used as parameter names in the URL query string.
queryValue	string	Values corresponding to query string keys.

Example

Example

await UTILITY.DownloadFileFromURL("https://file-examples.com/wp-content/storage/2017/02/file-sample_1MB.doc", "test.doc", {"Content-Type": "application/json","token": "1234567890"}, "application_directory", "cache_directory", [{ queryKey: "userId", queryValue: "1" },{ queryKey: "emailId", queryValue:"user@gmail.com" }]);

When the Promise resolves, the user input will be received in the output key inside a javascript object:

{
  output: 'file:///storage/emulated/0/Android/data/com.deltecs.dhqone/files/Cordova/simple.txt',
  success: true
}

OpenFile

The UTILITY.OpenFile() method allows users to dynamically open files directly from their devices locally. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.OpenFile(filePath,mimeType);

Parameters

Parameter	Accepts	Possible values
filePath	string	A valid absolute or relative path to a file.
mimeType	string	'application/pdf', 'application/vnd.ms-excel', 'application/msword', 'application/vnd.android.package-archive', 'audio/mpeg', 'video/mp4', 'image/png', 'image/jpeg', 'text/plain', 'text/csv'

Example

Example

await UTILITY.OpenFile("/storage/emulated/0/Download/file.pdf","application/pdf");

When the Promise resolves, the user input will be received in the output key inside a javascript object:

{
  output: 'file opened successfully'
}

ReadFile

The UTILITY.ReadFile() method allows users to dynamically read files directly from their devices locally. This method is supported only on Android and iOS platforms. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.ReadFile(filePath);

Parameters

Parameter	Accepts	Possible values
filePath	string	A valid absolute or relative path to a file.

Example

Example

await UTILITY.ReadFile("/storage/emulated/0/Download/file.pdf");

When the Promise resolves, the user input will be received in the output key inside a javascript object:

{
  output: 'This is file content.'
}

WriteFile

The UTILITY.WriteFile() method allows users to dynamically write files directly to their devices locally. This method is supported only on Android and iOS platforms. This method returns a Promise so the response needs to be captured using await keyword.

Usage

UTILITY.WriteFile(fileName,fileContent,appendData,contentType,pathOfAndroid,pathOfIos);

Parameters

Parameter	Accepts	Possible values
fileName	string	A valid file name with extension.
fileContent	string	The actual content of the file
appendData	boolean	true/false
contentType	string	'text/plain', 'application/pdf', 'application/msword', 'application/vnd.ms-excel', 'text/csv', 'application/json', 'image/png'
pathOfAndroid	string	'application_directory', 'document_directory', 'cache_directory'
pathOfIos	string	'application_directory', 'document_directory', 'cache_directory'

Example

Example

await UTILITY.WriteFile("test.pdf","This is a test file",true,"application/pdf","document_directory","application_directory");

When the Promise resolves, the user input will be received in the output key inside a javascript object:

{
  output: 'file:///storage/emulated/0/Android/data/com.deltecs.dhqone/files/Cordova/simple.txt',
  contentType: 'text/plain'
}

MpinVerification

The UTILITY.MpinVerification() method enables users to verify their MPIN (Mobile Personal Identification Number) as a means to securely access the app. This method is supported only on Android and iOS platforms. This method returns a Promise so the response needs to be captured using await keyword.

Usage

await UTILITY.MpinVerification();

When the Promise resolves, the user input will be received in the output key inside a javascript object:

{
  output: 'Verified'
}