umbot - v2.0.8
    Preparing search index...

    Class YandexSoundRequest

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

    https://yandex.ru/dev/dialogs/alice/doc/resource-sounds-upload-docpage/ Документация API Яндекс.Диалогов

    YandexSoundRequest

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    skillId

    Methods

    setOAuth call checkOutPlace downloadSoundFile getLoadedSounds deleteSound deleteSounds

    Constructors

    Properties

    skillId: null | string

    Идентификатор навыка, необходимый для корректного сохранения аудиофайлов

    YandexRequest Базовый класс для работы с API Яндекса

    Methods

    • Устанавливает OAuth-токен для авторизации

      Обновляет токен авторизации и заголовки запросов. При установке токена автоматически добавляется заголовок 'Authorization: OAuth {token}' ко всем последующим запросам.

      Parameters

      • oauth: null | string

        OAuth-токен для авторизации

      Returns void

      • Если передать null, авторизация будет отключена
      • Заголовок авторизации добавляется автоматически
      • Токен сохраняется для всех последующих запросов
      const api = new YandexRequest();

      // Установка нового токена
      api.setOAuth('new-token');
      // Теперь все запросы будут с заголовком:
      // Authorization: OAuth new-token

      // Сброс токена
      api.setOAuth(null);
      // Запросы будут без авторизации

    • Выполняет HTTP-запрос к API Яндекса

      Отправляет запрос к указанному эндпоинту API и обрабатывает полученный ответ.

      Type Parameters

      • T extends IYandexApi

        Тип ожидаемого ответа, наследующий интерфейс IYandexApi

      Parameters

      • Optionalurl: null | string = null

        URL-адрес эндпоинта API

      Returns Promise<null | T>

      • Результат запроса или null в случае ошибки

      Если произошла ошибка сети или сервера

      interface MyApiResponse extends IYandexApi {
        data: {
          id: string;
          name: string;
        };
      }

      const api = new YandexRequest('token');

      try {
        // Выполнение запроса
        const response = await api.call<MyApiResponse>('https://api.yandex.ru/endpoint');

        if (response) {
          // Обработка успешного ответа
          console.log('ID:', response.data.id);
          console.log('Name:', response.data.name);
        } else {
          // Обработка ошибки API
          console.error('Ошибка API:', api._error);
        }
      } catch (error) {
        // Обработка ошибок сети или сервера
        console.error('Ошибка запроса:', error);
      }

    • Проверка занятого места в хранилище аудиофайлов

      Returns Promise<null | IYandexCheckOutPlace>

      Информация о занятом месте:

      • total: общий доступный объем хранилища
      • used: использованный объем хранилища

      Для каждого аккаунта действует лимит в 1 ГБ. Учитывается размер сжатых файлов в формате OPUS

    • Загрузка аудиофайла с сервера

      Parameters

      • soundDir: string

        Путь к аудиофайлу на сервере

      Returns Promise<null | IYandexRequestDownloadSound>

      Информация о загруженном аудиофайле:

      • id: уникальный идентификатор файла
      • skillId: идентификатор навыка
      • size: размер файла в байтах
      • originalName: оригинальное имя файла
      • createdAt: дата и время загрузки
      • isProcessed: статус обработки файла
      • error: сообщение об ошибке (если есть)

    • Удаление конкретного аудиофайла по его идентификатору

      Parameters

      • soundId: string

        Идентификатор аудиофайла для удаления

      Returns Promise<null | string>

      'ok' при успешном удалении, null при ошибке

    • Удаление всех загруженных аудиофайлов

      Returns Promise<boolean>

      true если все файлы успешно удалены, false при ошибке

      Если при удалении произойдет ошибка, некоторые файлы могут остаться в хранилище

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods