Class SoundTokens

Модель для управления звуковыми файлами в различных платформах. Предоставляет единый интерфейс для работы со звуковыми файлами в Яндекс.Алисе, ВКонтакте, Telegram и Марусе.

SoundTokens

Example

// Создание и загрузка звукового файла для Telegram
const sound = new SoundTokens();
sound.path = '/path/to/audio.mp3';
sound.type = SoundTokens.T_TELEGRAM;
const token = await sound.getToken();
if (token) {
    console.log('Звуковой файл успешно загружен, токен:', token);
}

Hierarchy (View Summary)

Model<ISoundModelState>
- SoundTokens

Index

Constructors

constructor

new SoundTokens(appContext: AppContext): SoundTokens
Конструктор класса SoundTokens. Инициализирует все поля значениями по умолчанию.
Parameters
- appContext: AppContext
Returns SoundTokens
Overrides Model.constructor
- Defined in src/models/SoundTokens.ts:107

Properties

`Protected`_appContext

_appContext: AppContext

Контекст приложения.

dbController

dbController: IDbControllerModel | DbController

Контроллер для работы с базой данных Используется для выполнения запросов и управления данными

Example

// Получение данных через контроллер
const result = await this.dbController.select(
  { where: { id: 1 } },
  true
);

isAttachContent

isAttachContent: boolean

Флаг, указывающий, что передается содержимое файла. Если true, то path содержит содержимое файла, а не путь к нему.

Default Value

false

path

path: string | null

Расположение звукового файла (url/директория). Может быть URL-адресом звукового файла или путем к локальному файлу.

queryData

queryData: QueryData

Объект для хранения параметров запроса Содержит условия поиска и данные для обновления

Example

// Установка параметров запроса
this.queryData.setQuery({ id: 1 });
this.queryData.setData({ name: 'John' });

soundToken

soundToken: string | null

Идентификатор/токен звукового файла. Уникальный идентификатор, используемый для ссылки на звуковой файл в API платформы.

startIndex

startIndex: number = 0

Начальный индекс для итерации по данным. Используется при инициализации модели из массива

state

state: Partial<TState> = {}

Состояние модели Содержит текущие значения всех атрибутов

Example

// Установка значений
this.state.username = 'John';
this.state.age = 25;

// Получение значений
console.log(this.state.username);

type

type: number

Тип приложения, для которого загружен звуковой файл. Определяется одной из констант T_ALISA, T_VK, T_TELEGRAM или T_MARUSIA.

`Static` `Readonly`T_ALISA

T_ALISA: 0

Тип платформы: Яндекс.Алиса

`Static` `Readonly`T_MARUSIA

T_MARUSIA: 3

Тип платформы: Маруся

`Static` `Readonly`T_TELEGRAM

T_TELEGRAM: 2

Тип платформы: Telegram

`Static` `Readonly`T_VK

T_VK: 1

Тип платформы: ВКонтакте

Methods

add

add(): Promise<any>
Добавляет новую запись в базу данных

Returns Promise<any>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.add();
```
Inherited from Model.add
- Defined in src/models/db/Model.ts:396

attributeLabels

attributeLabels(): ISoundModelState
Возвращает метки атрибутов таблицы. Используется для отображения понятных названий полей.

Returns ISoundModelState
Объект с метками атрибутов
Overrides Model.attributeLabels
- Defined in src/models/SoundTokens.ts:149

destroy

destroy(): void
Закрывает соединение с базой данных

Returns void
Example
```
model.destroy();
```
Inherited from Model.destroy
- Defined in src/models/db/Model.ts:494

escapeString

escapeString(text: string | number): string
Экранирует специальные символы в строке
Parameters
- text: string | number
  Текст для экранирования
Returns string
Экранированная строка
Example
```
const safe = model.escapeString("O'Connor");
```
Inherited from Model.escapeString
- Defined in src/models/db/Model.ts:229

`Protected`getId

getId(): string | number | null
Определяет имя первичного ключа таблицы. Ищет поле с меткой 'id' или 'ID'

Returns string | number | null
Имя первичного ключа или null
Inherited from Model.getId
- Defined in src/models/db/Model.ts:254

getToken

getToken(): Promise<string | null>
Получает или создает токен звукового файла для указанной платформы. Метод автоматически определяет тип платформы и использует соответствующий API для загрузки и получения токена звукового файла.

Returns Promise<string | null>
Токен звукового файла или null в случае ошибки
Example
```
// Загрузка звукового файла для VK
const sound = new SoundTokens();
sound.path = '/path/to/voice.mp3';
sound.type = SoundTokens.T_VK;
const token = await sound.getToken();
if (token) {
    console.log('Звуковой файл успешно загружен, токен:', token);
}
```
- Defined in src/models/SoundTokens.ts:174

init

init(
    data:
        | IDbControllerResult<unknown>
        | IDbControllerResult<unknown>[]
        | null,
): void
Инициализирует модель данными
Parameters
- data: IDbControllerResult<unknown> | IDbControllerResult<unknown>[] | null
  Данные для инициализации
Returns void
Example
```
model.init({
  id: 1,
  username: 'John',
  age: 25
});
```
Inherited from Model.init
- Defined in src/models/db/Model.ts:278

isConnected

isConnected(): Promise<boolean>
Проверяет состояние подключения к базе данных

Returns Promise<boolean>
Promise - true если подключение активно
Example
```
const isConnected = await model.isConnected();
if (isConnected) {
  // Выполнение операций с базой данных
}
```
Inherited from Model.isConnected
- Defined in src/models/db/Model.ts:214

query

query(callback: TQueryCb): any
Выполняет произвольный запрос к базе данных
Parameters
- callback: TQueryCb
  Функция обратного вызова для выполнения запроса
Returns any
Результат выполнения запроса
Example
```
const result = await model.query(async (client, db) => {
  const collection = db.collection('users');
  return await collection.aggregate([
    { $match: { age: { $gt: 18 } } },
    { $group: { _id: '$city', count: { $sum: 1 } } }
  ]).toArray();
});
```
Inherited from Model.query
- Defined in src/models/db/Model.ts:482

remove

remove(): Promise<boolean>
Удаляет запись из базы данных

Returns Promise<boolean>
Promise - true если удаление успешно
Example
```
await model.remove();
```
Inherited from Model.remove
- Defined in src/models/db/Model.ts:417

rules

rules(): IModelRules[]
Определяет правила валидации для полей модели.

Returns IModelRules[]
Массив правил валидации
Overrides Model.rules
- Defined in src/models/SoundTokens.ts:129

save

save(isNew?: boolean): Promise<any>
Сохраняет данные модели в базу данных Если запись существует - обновляет, иначе создает новую
Parameters
- isNew: boolean = false
  Флаг создания новой записи
Returns Promise<any>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.save(); // Обновление существующей записи
await model.save(true); // Создание новой записи
```
Inherited from Model.save
- Defined in src/models/db/Model.ts:364

selectOne

selectOne(): Promise<IModelRes>
Выполняет поиск записи по первичному ключу

Returns Promise<IModelRes>
Promise с результатом запроса
Example
```
const result = await model.selectOne();
if (result.status) {
  model.init(result.data);
}
```
Inherited from Model.selectOne
- Defined in src/models/db/Model.ts:316

tableName

tableName(): string
Возвращает название таблицы/файла с данными.

Returns string
Название таблицы для хранения данных о звуковых файлах
Overrides Model.tableName
- Defined in src/models/SoundTokens.ts:120

update

update(): Promise<any>
Обновляет существующую запись в базе данных

Returns Promise<any>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.update();
```
Inherited from Model.update
- Defined in src/models/db/Model.ts:380

validate

validate(): void
Выполняет валидацию данных модели Может быть переопределен в дочерних классах

Returns void
Example
```
validate(): void {
  if (!this.state.username) {
    throw new Error('Username is required');
  }
}
```
Inherited from Model.validate
- Defined in src/models/db/Model.ts:246

where

where(where?: any, isOne?: boolean): Promise<IModelRes>
Выполняет произвольный запрос к базе данных
Parameters
- where: any = '1'
  Условия запроса
- isOne: boolean = false
  Флаг выборки одной записи
Returns Promise<IModelRes>
Promise с результатом запроса
Inherited from Model.where
- Defined in src/models/db/Model.ts:436

whereOne

whereOne(where?: any): Promise<boolean>
Выполняет запрос с выборкой одной записи
Parameters
- where: any = '1'
  Условия запроса
Returns Promise<boolean>
Promise - true если запись найдена
Example
```
const found = await model.whereOne({ id: 1 });
if (found) {
  console.log('Record found');
}
```
Inherited from Model.whereOne
- Defined in src/models/db/Model.ts:456

Class SoundTokens

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SoundTokens

Properties

Protected_appContext

dbController

Example

isAttachContent

Default Value

path

queryData

Example

soundToken

startIndex

state

Example

type

Static ReadonlyT_ALISA

Static ReadonlyT_MARUSIA

Static ReadonlyT_TELEGRAM

Static ReadonlyT_VK

Methods

add

Returns Promise<any>

Example

attributeLabels

Returns ISoundModelState

destroy

Returns void

Example

escapeString

Parameters

Returns string

Example

ProtectedgetId

Returns string | number | null

getToken

Returns Promise<string | null>

Example

init

Parameters

Returns void

Example

isConnected

Returns Promise<boolean>

Example

query

Parameters

Returns any

Example

remove

Returns Promise<boolean>

Example

rules

Returns IModelRules[]

save

Parameters

Returns Promise<any>

Example

selectOne

Returns Promise<IModelRes>

Example

tableName

Returns string

update

Returns Promise<any>

Example

validate

Returns void

Example

where

Parameters

`Protected`_appContext

`Static` `Readonly`T_ALISA

`Static` `Readonly`T_MARUSIA

`Static` `Readonly`T_TELEGRAM

`Static` `Readonly`T_VK

`Protected`getId