2.6 Application Features

The Application Features section provides access to application-level information and configuration.
It includes functions for retrieving version details and working with application settings.

These endpoints allow clients to adapt behavior based on the application context and configuration.

updateFile (Android, Windows, iOS) #

Updates a file or files that have been downloaded from the license server to the device at the activation of Signatus license.

This function also allows the wizard to update itself. Using this function, new version of the wizard or configuration updates can be distributed to all the devices of the customer. In case multiple files should be checked and updated, please use the function according to the example for update of multiple files.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function updateFile(arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function updateFile(arg);

Parameters description :

Example for one file only :

const arg = {
    "filename": "Wizard.zip",
    "showProgress": true,
    "restartAfterUpdate": true,
    "call": "onUpdateFile"
}
updateFile(arg);

/**
 * callback function for updateFile function
 * @param res - result in string format
 */
function onUpdateFile (res) {
    const result = JSON.parse(res);
}

const arg = {
    "filename": "Wizard.zip",
    "showProgress": true,
    "restartAfterUpdate": true,
    "call": "onUpdateFile"
}
updateFile(arg);

/**
 * callback function for updateFile function
 * @param res - result in string format
 */
function onUpdateFile (res) {
    const result = JSON.parse(res);
}

Example for muliple files :

const arg = {
    "filenames": "public.der,example.pdf,logo.png",
    "restartAfterUpdate": true,
    "call": "onUpdateFile"
}
updateFile(arg);

/**
 * callback function for updateFile function
 * @param res - result in string format
 */
function onUpdateFile (res) {
    const result = JSON.parse(res);
}

const arg = {
    "filenames": "public.der,example.pdf,logo.png",
    "restartAfterUpdate": true,
    "call": "onUpdateFile"
}
updateFile(arg);

/**
 * callback function for updateFile function
 * @param res - result in string format
 */
function onUpdateFile (res) {
    const result = JSON.parse(res);
}

Result example :

{
	"parameter": {
		"status": "OK",
		"message": "Všetko je aktuálne"
	}
}

{
	"parameter": {
		"status": "OK",
		"message": "Všetko je aktuálne"
	}
}

getVersion (Android, Windows, iOS) #

Returns the version of the SIGNATUS SDK of Signatus application installed on the device.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} - Returns version name in string format
 */
function getVersion (arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} - Returns version name in string format
 */
function getVersion (arg);

Example :

const value = getVersion ({});
// 4.5.1

const value = getVersion ({});
// 4.5.1

getInfo (Android, Windows, iOS) #

Returns information about the device. This data can be stored as metadata, written to an audit file, or embedded into PDF document properties to provide additional evidence of how the signature was created.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns device info in JSON format as string
 */
function getInfo (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns device info in JSON format as string
 */
function getInfo (arg);

Parameters description :

Example :

const arg = {
    "code": "All"
}
const res= getInfo(arg);
const result = JSON.parse(res);

const arg = {
    "code": "All"
}
const res= getInfo(arg);
const result = JSON.parse(res);

Result example :

{
	"UID": "00000000-57cd-abf3-0000-00000033c587",
	"IPAddress": "",
	"Version": "4.5.1",
	"MACAddress": "",
	"NetworkType": "Wi-Fi",
	"SerialNumber": "6e4572bbf5ff291c",
	"Manufacturer": "samsung",
	"Model": "SM-X610",
	"OSVersion": "16",
	"SDK": "36",
	"GPS": "48,89354 18,03928",
	"ApplicationId": "com.anasoft.signatus.app",
	"Battery": "{\"level\":98,\"isCharging\":true}",
	"OSId": "6e4572bbf5ff291c",
	"WifiInfo": "4",
	"NativeIntent": "false"
}

{
	"UID": "00000000-57cd-abf3-0000-00000033c587",
	"IPAddress": "",
	"Version": "4.5.1",
	"MACAddress": "",
	"NetworkType": "Wi-Fi",
	"SerialNumber": "6e4572bbf5ff291c",
	"Manufacturer": "samsung",
	"Model": "SM-X610",
	"OSVersion": "16",
	"SDK": "36",
	"GPS": "48,89354 18,03928",
	"ApplicationId": "com.anasoft.signatus.app",
	"Battery": "{\"level\":98,\"isCharging\":true}",
	"OSId": "6e4572bbf5ff291c",
	"WifiInfo": "4",
	"NativeIntent": "false"
}

setProfile (Android) #

Set a value of an item inside “My Profile” section of Signatus application installed on the device.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the profile were successfully set, false otherwise.
 */
function setProfile(arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the profile were successfully set, false otherwise.
 */
function setProfile(arg);

Parameters description :

Example :

const arg = {
    "code": "name",
    "data": "John Doe"
}
const isSucess = setProfile(arg);

const arg = {
    "code": "name",
    "data": "John Doe"
}
const isSucess = setProfile(arg);

getProfile (Android) #

Returns the value from an attribute stored within “My Profile” section of Signatus application installed on the device.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns profile attribute value
 */
function getProfile(arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns profile attribute value
 */
function getProfile(arg);

Parameters description :

Example :

const arg = {
    "code": "name"
}
const value = getProfile(arg);
// John Doe

const arg = {
    "code": "name"
}
const value = getProfile(arg);
// John Doe

deleteProfile (Android) #

Clears all data stored in the device’s My Profile section. My Profile is typically used to temporarily store information, such as login credentials for a configured REST channel during wizard execution. The wizard can define rules that control when this stored information should be removed.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {boolean} - Returns true if the profile were successfully deleted, false otherwise.
 */
function deleteProfile (arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {boolean} - Returns true if the profile were successfully deleted, false otherwise.
 */
function deleteProfile (arg);

Example :

const isSucess = deleteProfile({});

const isSucess = deleteProfile({});

setAppConfig (Android, Windows) #

Sets an internal SIGNATUS configuration parameter (not reachable via GUI). This way it is possible to customize the Signatus application from the wizard. Contact us in order to get the desired parameter and possible values to be set.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the config were successfully set, false otherwise.
 */
function setAppConfig (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the config were successfully set, false otherwise.
 */
function setAppConfig (arg);

Parameters description :

Example of configuring the generated certificate issuer name (instead of the default value CN=SIGNATUS,O=Anasoft APR,L=Bratislava,ST=Slovakia,C=SK)

const arg = {
    "code": "cert.issuer.name",
    "data": "CN=SIGNATURE,O=Company s.r.o,L=Bratislava,ST=Slovakia,C=SK"
}
const isSucess = setAppConfig (arg);

const arg = {
    "code": "cert.issuer.name",
    "data": "CN=SIGNATURE,O=Company s.r.o,L=Bratislava,ST=Slovakia,C=SK"
}
const isSucess = setAppConfig (arg);

* implementation for Windows is limited for some attributes only (“tag.compulsory.signatures”, “document.zoom.factor”, “cert.issuer.name”)

getAppConfig (Android) #

Gets the value of an internal SIGNATUS configuration parameter (not reachable via GUI). Contact us in order to get the desired parameter and possible output values.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns config attribute value
 */
function getAppConfig (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns config attribute value
 */
function getAppConfig (arg);

Parameters description :

Example :

const arg = {
    "code": "cert.issuer.name"
}
const value = getAppConfig(arg);

const arg = {
    "code": "cert.issuer.name"
}
const value = getAppConfig(arg);

setSettings (Android, Windows, iOS) #

Sets one of the SIGNATUS configuration parameters that are also reachable via the settings GUI. This way it is possible to customize the settings of Signatus application from the wizard.

See the getSettings function for the list of codes.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the settings were successfully set, false otherwise.
 */
function setSettings (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {boolean} - Returns true if the settings were successfully set, false otherwise.
 */
function setSettings (arg);

Parameters description :

Example :

const arg = {
    "code": "draw_mode",
    "data": "PEN"
}
const isSucess = setSettings (arg);

const arg = {
    "code": "draw_mode",
    "data": "PEN"
}
const isSucess = setSettings (arg);

getSettings (Android, Windows, iOS) #

Returns the current value of a SIGNATUS settings entry (one of the parameters reachable via the settings GUI). Similar to getAppConfig, but in case of function getAppConfig you can get the parameters NOT reachable via GUI.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns config attribute value
 */
function getSettings(arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {string} - Returns config attribute value
 */
function getSettings(arg);

Parameters description :

Example :

const arg = {
    "code": "draw_mode"
}
const value = getSettings(arg);
// SYSTEM , PEN or FINGER

const arg = {
    "code": "draw_mode"
}
const value = getSettings(arg);
// SYSTEM , PEN or FINGER

List of the settings codes:

Codes marked +suffix can be used without a suffix or with a number 1-5 appended to the code. The resulting 6 possible codes are used to distinguish among multiple channels of the same type (e.g. REST download).

* implementation for Windows is limited for some attributes only (“browse_rest_username”, “browse_rest_password”, “upload_web_username”, “upload_web_password”)

openPreferences (Android) #

Opens the Signatus preferences window. If Signatus is configured to launch directly into a wizard, this function allows administrators to access and modify application settings without stopping the wizard.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {boolean} - Returns true if the preferences were successfully opened, false otherwise.
 */
function openPreferences (arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {boolean} - Returns true if the preferences were successfully opened, false otherwise.
 */
function openPreferences (arg);

Example :

const isSucess = openPreferences ({});

const isSucess = openPreferences ({});

exportSettings (Android) #

Enables the export of application settings to an encrypted file. This functionality is available both in the application settings and through the wizard.

The encrypted settings file can be transferred to another device to easily replicate the configuration, or uploaded to the license server and distributed automatically to devices during license activation.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} Returns JSON object as string with keys : success : true / false path : path to exported file
 */
function exportSettings(arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} Returns JSON object as string with keys : success : true / false path : path to exported file
 */
function exportSettings(arg);

Example :

const res = exportSettings ({});
const result = JSON.parse(res);

const res = exportSettings ({});
const result = JSON.parse(res);

Result example :

{
	"success": true,
	"path": "/storage/emulated/0/Android/data/com.anasoft.signatus.app/files/Export/com.anasoft.signatus.app_preferences.xml"
}

{
	"success": true,
	"path": "/storage/emulated/0/Android/data/com.anasoft.signatus.app/files/Export/com.anasoft.signatus.app_preferences.xml"
}

scanLicense (Android) #

Opens a barcode reader to scan QR license code. After scanning, it connects to the license server and downloads the license and all the related configuration files available.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function scanLicense (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function scanLicense (arg);

Parameters description :

Example :

const arg = {
    "call": "onScanLicense"
}
scanLicense(arg);

/**
 * callback function for scanLicense function
 * @param res - result in string format
 */
function onScanLicense (res) {
    const result = JSON.parse(res);
}

const arg = {
    "call": "onScanLicense"
}
scanLicense(arg);

/**
 * callback function for scanLicense function
 * @param res - result in string format
 */
function onScanLicense (res) {
    const result = JSON.parse(res);
}

Result example :

{
	"parameter": {
		"suceess": true
	}
}

{
	"parameter": {
		"suceess": true
	}
}

getLicense (Android) #

Returns information about Signatus license activated on the device.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} - Returns license info in JSON format as string
 */
function getLicense(arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {string} - Returns license info in JSON format as string
 */
function getLicense(arg);

Example :

const res= getLicense({});
const result = JSON.parse(res);

const res= getLicense({});
const result = JSON.parse(res);

Result example :

{
	"activation_date": "15.12.2025",
	"expiry_date": "31.07.2030",
	"last_modified": "01.09.2025",
	"license_hash": "",
	"json_data": {},
	"pdf_watermark": false
}

{
	"activation_date": "15.12.2025",
	"expiry_date": "31.07.2030",
	"last_modified": "01.09.2025",
	"license_hash": "",
	"json_data": {},
	"pdf_watermark": false
}

setTitleBar (Android) #

Sets the text , color and visibility of the Android action bar of a wizard.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function setTitleBar (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function setTitleBar (arg);

Parameters description :

Example :

const arg = {
    "text" : "My wizard",
    "color" : "#ff0000",
    "state" : "on"
};
setTitleBar (arg);

const arg = {
    "text" : "My wizard",
    "color" : "#ff0000",
    "state" : "on"
};
setTitleBar (arg);

setProgress (Android) #

Sets the value of the progress indicator displayed in the Android system task bar during wizard execution. The progress bar shows the current wizard step and the total number of steps to be completed.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function setProgress (arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void} 
 */
function setProgress (arg);

Parameters description :

Example :

const arg = {
    "progress" : 1,
    "max" : 5
};
setProgress(arg);

const arg = {
    "progress" : 1,
    "max" : 5
};
setProgress(arg);

Result :

getChannels (Android) #

Returns information about all upload channels configured in the Signatus application settings.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {Object} - Returns JSON Array about all upload channels configured in the Signatus application settings.
 */
function getChannels(arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {Object} - Returns JSON Array about all upload channels configured in the Signatus application settings.
 */
function getChannels(arg);

Example :

const result = getChannels({});

const result = getChannels({});

Result example :

[
	{
		"name": "SignedLocal"
	},
	{
		"name": "SignedDocuments"
	}
]

[
	{
		"name": "SignedLocal"
	},
	{
		"name": "SignedDocuments"
	}
]

clearWebView (Android) #

Clears the browsing history, cache, and form data of the web view used by the wizard. This is especially useful at the end of a multi-user session to ensure that information entered by one user (such as login credentials) is not visible to subsequent users.

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {void}
 */
function clearWebView(arg);

/**
 * @param {Object} arg- Empty JSON object.
 * @returns {void}
 */
function clearWebView(arg);

Example :

clearWebView ({});

clearWebView ({});

cancel (Android, Windows, iOS) #

The cancel function is used to exit the HTML wizard or to control the Signatus application state, such as minimizing, restarting, or closing the application.

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void}
 */
function cancel(arg);

/**
 * @param {Object} arg- Parameter JSON object.
 * @returns {void}
 */
function cancel(arg);

Parameters description :

Example :

const arg = {
    "state": "off"
};
cancel(arg);

const arg = {
    "state": "off"
};
cancel(arg);