Тип TypeB24

import { type TypeB24 } from '@bitrix24/b24jssdk'

Реализация:

• AbstractB24
  • Hook
  • Frame

Геттеры

isInit

get isInit(): boolean

Указывает, инициализированы ли данные. Аналог функции

auth

get auth(): AuthActions

Возвращает интерфейс AuthActions для работы с авторизацией.

Методы

init

init(): Promise<void>

Используется для инициализации данных.

destroy

destroy(): void

Используется для удаления.

getLogger

getLogger(): LoggerBrowser

Возвращает текущий логгер.

setLogger

setLogger(
	logger: LoggerBrowser
): void

Устанавливает логгер.

getTargetOrigin

getTargetOrigin(): string

Возвращает адрес Битрикс24 (например, https://name.bitrix24.com). Аналог функции

getTargetOriginWithPath

getTargetOriginWithPath(): string

Возвращает адрес rest-api Битрикс24 (например, https://name.bitrix24.com/rest). Аналог функции

callMethod

callMethod(
	method: string,
    params?: object,
    start?: number
): Promise<AjaxResult>

Вызывает метод rest-api с указанными параметрами.

Возвращает Promise, который разрешается в AjaxResult

Аналог функции

callListMethod

callListMethod(
    method: string,
    params?: object,
    progress?: null|((progress: number) => void),
    customKeyForResult?: string|null
): Promise<Result>

Вызывает метод rest-api для списочного метода с указанными параметрами.

Параметр	Тип	Описание
method	string	Метод запроса.
params	object	Параметры запроса.
progress	null|((progress: number) => void)	Обработка шагов.
customKeyForResult	string|null	Пользовательское поле для группировки.

Возвращает Promise, который разрешается в Result

fetchListMethod

fetchListMethod(
	method: string,
    params?: any,
    idKey?: string,
    customKeyForResult?: string|null
): AsyncGenerator<any[]>

Вызывает метод rest-api для списочного метода и возвращает объект-генератор.

Параметр	Тип	Описание
method	string	Метод запроса.
params	any	Параметры запроса.
idKey	string	Имя поля ID сущности ('ID' или 'id').
customKeyForResult	string|null	Пользовательское поле для группировки.

callBatch

callBatch(
	calls: Array<any>|object,
    isHaltOnError?: boolean
): Promise<Result>

Вызывает пакетный запрос с максимальным количеством команд не более 50.

Параметр	Тип	Описание
calls	Array<any>|object	Пакет запросов.
isHaltOnError	boolean	Прекращение выполнения при ошибке.

Возвращает Promise, который разрешается в AjaxResult

Аналог функции

callBatchByChunk

callBatchByChunk(
	calls: Array<any>,
    isHaltOnError: boolean
): Promise<Result>

Вызывает пакетный запрос с любым количеством команд.

Параметр	Тип	Описание
calls	Array<any>	Пакет запросов.
isHaltOnError	boolean	Прекращение выполнения при ошибке.

Возвращает Promise, который разрешается в AjaxResult

getHttpClient

getHttpClient(): TypeHttp

Возвращает HTTP клиент реализующий интерфейс TypeHttp для запросов.