Class YandexSoundRequest

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

See

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

Hierarchy

Constructors

constructor

Properties

_error _oauth _request skillId

Methods

_log call checkOutPlace deleteSound deleteSounds downloadSoundFile getLoadedSounds 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

  • Проверить занятое место.

    Для каждого аккаунта на Яндексе действует лимит на загрузку аудиофайлов — вы можете хранить на Диалогах не больше 1 ГБ файлов. Обратите внимание, лимит учитывает размер сжатых аудиофайлов, а не размер оригиналов. Диалоги конвертируют загруженные аудиофайлы в формат OPUS и обрезают их до 120 секунд — размер этих файлов и будет учитываться в лимите.

    Returns

    Promise [

    • int total: Все доступное место.
    • int used: Занятое место. ]

    Api

    Returns Promise<null | IYandexCheckOutPlace>

deleteSound

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

    Returns

    Promise

    Api

    Parameters

    • soundId: string

      Идентификатор аудиофайла, который необходимо удалить.

    Returns Promise<null | string>

deleteSounds

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

    Returns

    Promise

    Api

    Returns Promise<boolean>

downloadSoundFile

  • Загрузить аудиофайл.

    Returns

    Promise [

    • string id: Идентификатор аудиофайла.
    • string skillId: Идентификатор навыка.
    • int|null size: Размер файла.
    • string originalName: Название загружаемого файла.
    • string createdAt: Дата создания файла.
    • bool isProcessed: Флаг готовности файла.
    • error: Текст ошибки. ]

    Api

    Parameters

    • soundDir: string

      Расположение аудиофайла на сервере.

    Returns Promise<null | IYandexRequestDownloadSound>

getLoadedSounds

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

    Returns

    Promise<IYandexRequestDownloadSound[]> [ [ - string id: Идентификатор аудиофайла. - string skillId: Идентификатор навыка. - int|null size: Размер файла. - string originalName: Название загружаемого файла. - string createdAt: Дата создания файла. - bool isProcessed: Флаг готовности файла. - error: Текст ошибки. ] ]

    Api

    Returns Promise<null | IYandexRequestDownloadSound[]>

setOAuth

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

    Api

    Parameters

    • oauth: null | string

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

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc