@ebenos/viber-elements/build/viberAPI/interfaces.d.ts

Elements Library for the Ebony framework.

import { RichMedia, Picture, Button } from './attachments';
import { Carousel } from './carousel';
import { Keyboard } from './keyboard';
import { ITrackingData } from '@ebenos/framework/lib/interfaces/trackingData';
export declare type ScaleType = 'crop' | 'fill' | 'fit';
export declare type ActionType = 'reply' | 'open-url' | 'location-picker' | 'share-phone' | 'none';
export declare type TextVAlign = 'top' | 'middle' | 'bottom';
export declare type TextHAlign = 'left' | 'center' | 'right';
export declare type MediaType = 'picture' | 'gif';
export declare type TextSize = 'small' | 'regular' | 'large';
export declare type InputFieldState = 'regular' | 'minimized' | 'hidden';
export declare type OpenURLType = 'internal' | 'external';
export declare type InternalBrowserActionButton = 'forward' | 'send' | 'open-externally' | 'send-to-bot' | 'none';
export declare type InternalBrowserTitleType = 'domain' | 'default';
export declare type InternalBrowserMode = 'fullscreen' | 'fullscreen-portrait' | 'fullscreen-landscape' | 'partial-size';
export declare type InternalBrowserFooterType = 'default' | 'hidden';
export declare type MessageType = 'text' | 'picture' | 'video' | 'file' | 'location' | 'contact' | 'sticker' | 'RichMedia content' | 'rich_media' | 'url';
export declare type OpenURLMediaType = 'not-media' | 'video' | 'gif' | 'picture';
/** MESSAGE */
export interface ISender {
    name: string;
    avatar?: string;
}
export interface IGeneralMessageOptions {
    sender: ISender;
    tracking_data?: ITrackingData;
    keyboard?: Keyboard;
    attachment?: Picture;
}
export interface ITextOptions extends IGeneralMessageOptions {
    text: string;
}
export interface IRichMediaMessageOptions extends IGeneralMessageOptions {
    rich_media: RichMedia | Carousel;
}
export interface IURLOptions extends IGeneralMessageOptions {
    media: string;
}
export declare type IMessageOptions = ITextOptions | IURLOptions | IRichMediaMessageOptions;
/** ATTACHMENTS */
export interface IPictureOptions {
    media: string;
    thumbnail?: string;
}
export interface IRichMediaOptions {
    ButtonsGroupColumns?: number;
    ButtonsGroupRows?: number;
    BgColor?: string;
    Buttons: Button[];
    HeightScale?: number;
}
/** KEYBOARD */
export interface IKeyboardOptions {
    Buttons: Button[];
    BgColor?: string;
    DefaultHeight?: boolean;
    CustomDefaultHeight?: number;
    ButtonsGroupColumns?: number;
    ButtonsGroupRows?: number;
    InputFieldState?: InputFieldState;
    FavoritesMetadata?: string;
}
export interface IButtonOptions {
    Columns?: number;
    Rows?: number;
    ActionType?: ActionType;
    ActionBody: string;
    Image?: string;
    Text?: string;
    TextSize?: TextSize;
    TextVAlign?: TextVAlign;
    TextHAlign?: TextHAlign;
    Silent?: boolean;
    BgColor?: string;
    BgMediaType?: MediaType;
    BgMedia?: string;
    BgMediaScaleType?: ScaleType;
    ImageScaleType?: ScaleType;
    BgLoop?: boolean;
    TextPaddings?: number[];
    TextOpacity?: number;
    OpenURLType?: OpenURLType;
    OpenURLMediaType?: OpenURLMediaType;
    TextBgGradientColor?: string;
    TextShouldFit?: boolean;
    InternalBrowser?: IInternalBrowser;
    Map?: ICoordinates;
    Frame?: IFrame;
    MediaPlayer?: IMediaPlayer;
}
export interface IInternalBrowser {
    ActionButton?: InternalBrowserActionButton;
    ActionPredefinedURL?: string;
    TitleType?: InternalBrowserTitleType;
    CustomTitle?: string;
    Mode?: InternalBrowserMode;
    FooterType?: InternalBrowserFooterType;
    ActionReplyData?: string;
}
export interface ICoordinates {
    Latitude: string;
    Longitude: string;
}
export interface IFrame {
    BorderWidth?: number;
    BorderColor?: string;
    CornerRadius?: number;
}
export interface IMediaPlayer {
    Title?: string;
    Subtitle?: string;
    ThumbnailURL?: string;
    Loop?: boolean;
}
export interface ISerializedGeneralMessage {
    type: MessageType;
    sender: ISender;
    min_api_version: string;
    tracking_data?: string;
    attachment?: Picture;
    keyboard?: ISerializedKeyboard;
}
export interface ISerializedText extends ISerializedGeneralMessage {
    text: string;
}
export interface ISerializedURL extends ISerializedGeneralMessage {
    media: string;
}
export interface ISerializedRichMediaMessage extends ISerializedGeneralMessage {
    rich_media: ISerializedRichMedia;
}
export interface ISerializedImage extends ISerializedGeneralMessage {
    attachment: Picture;
}
export declare type ISerializedMessage = ISerializedText | ISerializedURL | ISerializedRichMediaMessage;
export interface ISerializedKeyboard {
    Buttons: ISerializedButton[];
    InputFieldState: InputFieldState;
    DefaultHeight: boolean;
    ButtonsGroupColumns: number;
    ButtonsGroupRows: number;
    BgColor?: string;
    CustomDefaultHeight?: number;
    FavoritesMetadata?: string;
}
export interface ISerializedButton {
    Columns?: number;
    Rows?: number;
    ActionType?: ActionType;
    ActionBody: string;
    Image?: string;
    Text?: string;
    TextSize?: TextSize;
    TextVAlign?: TextVAlign;
    TextHAlign?: TextHAlign;
    Silent?: boolean;
    BgColor?: string;
    BgMediaType?: MediaType;
    BgMedia?: string;
    BgMediaScaleType?: ScaleType;
    ImageScaleType?: ScaleType;
    BgLoop?: boolean;
    TextPaddings?: number[];
    TextOpacity?: number;
    OpenURLType?: OpenURLType;
    OpenURLMediaType?: OpenURLMediaType;
    TextBgGradientColor?: string;
    TextShouldFit?: boolean;
    InternalBrowser?: IInternalBrowser;
    Map?: ICoordinates;
    Frame?: IFrame;
    MediaPlayer?: IMediaPlayer;
}
export interface ISerializedRichMedia {
    Type: 'rich_media';
    Buttons: ISerializedButton[];
    HeightScale: number;
    ButtonsGroupColumns?: number;
    ButtonsGroupRows?: number;
    BgColor?: string;
}
//# sourceMappingURL=interfaces.d.ts.map