umbot
Version:
Мультиплатформенный фреймворк для создания голосовых навыков и чат-ботов с единой бизнес-логикой. Встроенная поддержка ВКонтакте, Telegram, Viber, MAX, Яндекс Алисы, Маруси и Сбера SmartApp. Архитектура на адаптерах позволяет подключать любые другие платф
97 lines (96 loc) • 2.33 kB
TypeScript
import { IMaxButtonObject, IMaxMessage } from '../../Max/interfaces/IMaxPlatform';
/**
* @interface IMaxCard
* Интерфейс для карточки Max.
*/
export interface IMaxCard {
/**
* Тип карточки.
*/
type: 'image';
/**
* Массив элементов карточки.
* Каждый элемент представляет собой отдельную карточку в карусели.
*/
payload: {
/**
* Ссылка на изображение.
*/
url?: string;
/**
* Токен изображения.
*/
token?: string;
/**
* Массив токенов изображений.
*/
photos?: string[];
};
}
/**
* @interface IMaxCard
* Интерфейс для аудио Max.
*/
export interface IMaxAudio {
/**
* Тип аудио.
*/
type: 'audio';
/**
* элемент аудио
*/
payload: {
/**
* Токен аудиофайла.
*/
token?: string;
};
}
/**
* Тип для загрузки файла
*/
export type TMaxUploadFile = 'image' | 'video' | 'audio' | 'file';
/**
* Интерфейс для загрузки файла в Max
*/
export interface IMaxUploadFile {
/**
* URL для загрузки файла
*/
url: string;
/**
* Видео- или аудио-токен для отправки сообщения
*/
token?: string;
}
/**
* Параметры для отправки сообщения
*/
export interface IMaxParams {
/**
* Настройки для отображения клавиатуры
*/
keyboard?: IMaxButtonObject;
/**
* Настройки для отображения вложений
*/
attachments?: (IMaxAudio | IMaxCard)[] | null;
}
/**
* Интерфейс для API Max
*/
export interface IMaxAppApi {
/**
* Дополнительные параметры
*/
[name: string]: unknown;
}
/**
* Интерфейс для отправки сообщения
*/
export interface IMaxSendMessage extends IMaxAppApi {
/**
* Само содержимое сообщения
*/
message: IMaxMessage;
}