Class SoundTokens

Hierarchy

Model
- SoundTokens

Index

Constructors

Properties

dbController isAttachContent path queryData soundToken startIndex type T_ALISA T_MARUSIA T_TELEGRAM T_VK

Methods

add attributeLabels destroy escapeString getId getToken init isConnected query remove rules save selectOne tableName update validate where whereOne

Constructors

constructor

new SoundTokens(): SoundTokens
SoundTokens constructor.

Returns SoundTokens
Overrides Model.constructor
- Defined in src/models/SoundTokens.ts:40

Properties

dbController

dbController: IDbControllerModel

isAttachContent

isAttachContent: boolean

True если передается содержимое файла. По умолчанию: false.

Default Value

false

path

path: null | string

Расположение звукового файла(url|/директория).

queryData

queryData: QueryData

soundToken

soundToken: null | string

Идентификатор/токен мелодии.

startIndex

startIndex: number = 0

Стартовое значение для индекса.

type

type: number

Тип приложения, для которого загружена мелодия.

`Static` `Readonly` T_ALISA

T_ALISA: 0 = 0

`Static` `Readonly` T_MARUSIA

T_MARUSIA: 3 = 3

`Static` `Readonly` T_TELEGRAM

T_TELEGRAM: 2 = 2

`Static` `Readonly` T_VK

T_VK: 1 = 1

Methods

add

add(): Promise<any>
Добавление значения в таблицу.

Returns

Api

Returns Promise<any>
Inherited from Model.add
- Defined in src/models/db/Model.ts:206

attributeLabels

attributeLabels(): object
Название атрибутов таблицы.

Returns
object

Api

Returns object
Overrides Model.attributeLabels
- Defined in src/models/SoundTokens.ts:84

destroy

destroy(): void
Удаление подключения к БД

Returns void
Inherited from Model.destroy
- Defined in src/models/db/Model.ts:283

escapeString

escapeString(text: string | number): string
Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

Returns
string

Api
Parameters
- text: string | number
  
  Исходный текст.
Returns string
Inherited from Model.escapeString
- Defined in src/models/db/Model.ts:78

`Protected` getId

getId(): null | string | number
Возвращаем название уникального ключа таблицы.

Returns
number|string

Returns null | string | number
Inherited from Model.getId
- Defined in src/models/db/Model.ts:94

getToken

getToken(): Promise<null | string>
Получение идентификатора/токена мелодии.

Returns

Api

Returns Promise<null | string>
- Defined in src/models/SoundTokens.ts:98

init

init(data: null | IDbControllerResult | IDbControllerResult[]): void
Инициализация данных для модели.

Api
Parameters
- data: null | IDbControllerResult | IDbControllerResult[]
  
  Массив с данными.
Returns void
Inherited from Model.init
- Defined in src/models/db/Model.ts:113

isConnected

isConnected(): Promise<boolean>
Проверка подключения к источнику данных. При использовании БД, проверяется статус подключения. Если удалось подключиться, возвращается true, в противном случае false. При сохранении данных в файл, всегда возвращается true.

Returns

Returns Promise<boolean>
Inherited from Model.isConnected
- Defined in src/models/db/Model.ts:67

query

query(callback: Function): any
Выполнение произвольного запрос к базе данных.

Returns

Api
Parameters
- callback: Function
  
  Непосредственно запрос к бд.
Returns any
Inherited from Model.query
- Defined in src/models/db/Model.ts:276

remove

remove(): Promise<boolean>
Удаление значения из таблицы.

Returns

Api

Returns Promise<boolean>
Inherited from Model.remove
- Defined in src/models/db/Model.ts:224

rules

rules(): IModelRules[]
Основные правила для полей.

Returns
IModelRules[]

Api

Returns IModelRules[]
Overrides Model.rules
- Defined in src/models/SoundTokens.ts:64

save

save(isNew?: boolean): Promise<any>
Сохранение значения в базу данных. Если значение уже есть в базе данных, то данные обновятся. Иначе добавляется новое значение.

Returns

Api
Parameters
- isNew: boolean = false
  
  Добавить новую запись в базу данных без поиска по ключу.
Returns Promise<any>
Inherited from Model.save
- Defined in src/models/db/Model.ts:184

selectOne

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

Returns

Api

Returns Promise<IModelRes>
Inherited from Model.selectOne
- Defined in src/models/db/Model.ts:146

tableName

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

Returns
string

Api

Returns string
Overrides Model.tableName
- Defined in src/models/SoundTokens.ts:54

update

update(): Promise<any>
Обновление значения в таблице.

Returns

Api

Returns Promise<any>
Inherited from Model.update
- Defined in src/models/db/Model.ts:195

validate

validate(): void
Валидация значений полей для таблицы.

Api

Returns void
Inherited from Model.validate
- Defined in src/models/db/Model.ts:86

where

where(where?: any, isOne?: boolean): Promise<IModelRes>
Выполнение запроса к данным.

Returns

Api
Parameters
- where: any = '1'
  
  Запрос к таблице.
- isOne: boolean = false
  
  Вывести только 1 результат. Используется только при поиске по файлу.
Returns Promise<IModelRes>
Inherited from Model.where
- Defined in src/models/db/Model.ts:243

whereOne

whereOne(where?: any): Promise<boolean>
Выполнение запроса и инициализация переменных в случае успешного запроса.

Returns

Api
Parameters
- where: any = '1'
  
  Запрос к таблице.
Returns Promise<boolean>
Inherited from Model.whereOne
- Defined in src/models/db/Model.ts:260

Generated using TypeDoc