Set Settings for the Application BX24.appOption.set

BX24.appOption.set(string name, mixed value[, Function callback]): void;

The method BX24.appOption.set sets global settings for the current application.

Setting application values is only available to users with application management access permission (see BX24.isAdmin). A completion handler may be required for application settings (see the callback parameter below).

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

Parameter code

value*
mixed

Parameter value

callback
function

Callback after saving. The current application settings will be passed as an argument

Code Example

BX24.init(() => {
            BX24.appOption.set('param_str', 'str1', (params) => console.log(params));
            BX24.appOption.set('param_numb', 1);
        });

How to Use Examples in Documentation

Continue Learning

Previous
Get User Settings
Next
Get Application Settings