Формат возвращаемого значения

Раздел предназначен для разработчиков встроенных приложений.

Единый формат возвращаемого значения для методов асинхронного выполнения действий.

Описание методов JS API приведено в разделе Методы JS API.

Методы выполнения действий возвращают объект Promise, принимающий одно из состояний:

  • При успешном выполнении действия (сохранение формы, запуск действия и др.) метод возвращает SuccessResult, формат которого определен в описании метода:

    Promise.resolve(object: SuccessResult)

  • При отмене выполнения действия пользователем (нажатие кнопки Отмена, закрытие формы) метод возвращает пустое или неопределенное значение:

    • Promise.resolve(null)

    • Promise.resolve(undefined)

  • При возникновении ошибке (ограничение прав и др.) метод возвращает ошибку:

    Promise.reject(error: Error)

Определение типа:

Copy 
type ResolveResult =
    // в случае успешного выполнения действия возвращаются данные, формат которых определен в описаниях конкретных методов
    SuccessResult
    // в случае отмены выполнения действия пользователем
    | null | undefined

// в случае ошибки
type RejectResult = Error

/**
 * Выполняет какое-то асинхронное действие
 *
 * @param {any[]} args аргументы метода
 * @return {Promise<ResolveResult, RejectResult>} результат работы метода
 */
declare function someAsyncActionMethod(...args: any[]): Promise<ResolveResult | RejectResult>