Класс OptionsManager

Используется для управления опциями приложения или пользователя в Битрикс24. Он расширяет функциональностьAbstractHelper и предоставляет методы для получения, кодирования и сохранения опций.

TIP

Работу с OptionsManager можно протестировать в примере и примере.

Геттеры

data

get data(): Map<string, any>

Возвращает Map данных опций.

Методы

getSupportTypes

static getSupportTypes(): TypeOption[]

Возвращает массив поддерживаемых типов опций TypeOption.

prepareArrayList

static prepareArrayList(list: any): any[]

Преобразует входные данные в массив, если это возможно.

reset

reset(): void

Сбрасывает данные опций

getJsonArray

getJsonArray(
	key: string,
	defValue: any[] = []
): any[]

Возвращает значение опции как массив.

getJsonObject

getJsonObject(
	key: string,
	defValue: Object = {}
): Object

Возвращает значение опции как объект.

getFloat

getFloat(
	key: string,
	defValue: number = 0.0
): number

Возвращает значение опции как число с плавающей запятой.

getInteger

getInteger(
	key: string,
	defValue: number = 0
): number

Возвращает значение опции как целое число.

getBoolYN

getBoolYN(
	key: string,
	defValue: boolean = true
): boolean

Возвращает значение опции как булево значение (да/нет).

getBoolNY

getBoolNY(
	key: string,
	defValue: boolean = false
): boolean

Возвращает значение опции как булево значение (нет/да).

getString

getString(
	key: string,
	defValue: string = ''
): string

Возвращает значение опции как строку.

getDate

getDate(
	key: string,
	defValue: null|DateTime = null
): null|DateTime

Возвращает значение опции как объект DateTime.

encode

encode(
	value: any
): string

Кодирует значение в строку JSON

decode

decode(
	data: string,
	defaultValue: any
): any

Декодирует строку JSON в объект.

save

async save(
	options: any,
	optionsPull?: {
		moduleId: string,
		command: string,
		params: any
	}
): Promise<Result>

Сохраняет опции и отправляет событие через Pull

Типы данных

TypeOption

Перечисление TypeOption определяет типы опций.

• NotSet: Не установлено.
• JsonArray: JSON массив.
• JsonObject: JSON объект.
• FloatVal: Число с плавающей запятой.
• IntegerVal: Целое число.
• BoolYN: Булево значение (да/нет).
• StringVal: Строка.