General Methods and Events

Several general methods available to the application regardless of the permissions requested by the application:

Method

Description

scope

Displays permissions.

app.info

Displays application information.

access.name

Retrieves access permission names.

server.time

Returns the current server time in ATOM format.

feature.get

Checks the availability of features on the account.

method.get

Checks the availability of a specific method.

Method

Description

user.admin

Determines if the current user has permissions to manage application settings.

user.access

Determines if the current user has at least one of the specified ACCESS permissions.

Storing and Retrieving Application Settings

Method

Description

app.option.set

Set your application settings to be stored in Bitrix24.

app.option.get

Retrieve saved application settings from Bitrix24.

user.option.set

Set your current user settings to be stored in Bitrix24.

user.option.get

Retrieve saved settings of the current user from Bitrix24.

System Events

Event

Description

OnAppInstall

Triggered after the application is successfully installed on a specific Bitrix24 account.

OnAppUninstall

Triggered after the application is removed from a specific Bitrix24 account.

OnAppMethodConfirm

Triggered after the portal administrator allows the use of a special class of methods.

onAppPayment

Triggered when the application is paid for.

onAppUserAdd

Triggered when a user is added to Bitrix24.