Class YandexImageRequest

Класс отвечающий за загрузку изображений в навык Алисы.

See

(https://yandex.ru/dev/dialogs/alice/doc/resource-upload-docpage/) Смотри тут

Hierarchy

Constructors

constructor

Properties

_error _oauth _request skillId

Methods

_log call checkOutPlace deleteImage deleteImages downloadImageFile downloadImageUrl getLoadedImages setOAuth

Constructors

constructor

Properties

Protected _error

_error: null | string

Текст с ошибкой

Protected _oauth

_oauth: undefined | null | string

Авторизационный токен. О том как получить авторизационный токен сказано тут:

See

(https://yandex.ru/dev/dialogs/alice/doc/resource-upload-docpage/#http-images-load__auth) Смотри тут

Protected _request

_request: Request

Отправка запроса.

See

Request Смотри тут

skillId

skillId: null | string

Идентификатор навыка, необходимый для корректного сохранения изображения (Обязательный параметр)

See

YandexRequest Смотри тут

Methods

Protected _log

call

  • Отправка запроса для обработки данных.

    Returns

    Promise

    Api

    Type Parameters

    Parameters

    • url: null | string = null

      Адрес запроса.

    Returns Promise<null | T>

checkOutPlace

deleteImage

  • Удаление выбранного изображения. В случае успеха вернет 'ok'.

    Returns

    Promise

    Api

    Parameters

    • imageId: string

      Идентификатор изображения, которое необходимо удалить.

    Returns Promise<null | string>

deleteImages

  • Удаление всех изображений. Если при удалении произошел сбой, то изображение останется. Чтобы точно удалить все изображения лучше использовать грубое удаление.

    Returns

    boolean

    Api

    Returns Promise<boolean>

downloadImageFile

  • Загрузка изображения из файла.

    Returns

    Promise [

    • string id: Идентификатор изображения.
    • string origUrl: Адрес изображения.
    • int size: Размер изображения.
    • int createdAt: Дата загрузки. ]

    Api

    Parameters

    • imageDir: string

      Путь к картинке, расположенной на сервере.

    Returns Promise<null | IYandexRequestDownloadImage>

downloadImageUrl

  • Загрузка изображения из интернета.

    Returns

    Promise [

    • string id: Идентификатор изображения.
    • string origUrl: Адрес изображения.
    • int size: Размер изображения.
    • int createdAt: Дата загрузки. ]

    Api

    Parameters

    • imageUrl: string

      Адрес изображения из интернета.

    Returns Promise<null | IYandexRequestDownloadImage>

getLoadedImages

  • Просмотр всех загруженных изображений.

    Returns

    Promise<IYandexRequestDownloadImage[]> [ [ - string id: Идентификатор изображения. - string origUrl: Адрес изображения. - int size: Размер изображения. - int createdAt: Дата загрузки. ] ]

    Api

    Returns Promise<null | IYandexRequestDownloadImage[]>

setOAuth

  • Установка и инициализация токена.

    Api

    Parameters

    • oauth: null | string

      Авторизационный токен для загрузки данных.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc