App Configurations in BX24.JS: Methods Overview

Two objects are used to work with app configurations:

• BX24.userOption — works with the current user's configurations. Setting a user configuration value takes effect immediately
• BX24.appOption — works with general app configurations. App configurations may require a completion handler, the callback parameter in BX24.appOption.set

Quick navigation: All Methods

Operating ConditionsOperating Conditions

• The BX24.userOption and BX24.appOption functions are available in the app after the library is initialized via the BX24.init method
• BX24.userOption reads and retains the current user's configurations
• BX24.appOption reads and retains the general configurations of the current app
• Saving general app configurations is only available to users with app management permissions. Before calling BX24.appOption.set, verify permissions using the BX24.isAdmin method

How to Choose a Configuration ObjectHow to Choose a Configuration Object

If needed	Use
Save setting only for the current user	BX24.userOption.set
Read current user setting	BX24.userOption.get
Save global application setting	BX24.appOption.set
Read global application setting	BX24.appOption.get

Getting StartedGetting Started

1. Initialize the library using the BX24.init method
2. If an app configuration is required, verify administrator permissions using the BX24.isAdmin method
3. Retain the value using the set method
4. Retrieve the value using the get method

Overview of MethodsOverview of Methods

Method	Description
BX24.userOption.set	Sets settings for the current user
BX24.userOption.get	Returns settings for the current user
BX24.appOption.set	Sets global settings for the current application
BX24.appOption.get	Returns setting by its code