whatsapp-api-js/lib/messages/text.d.ts

A TypeScript server agnostic Whatsapp's Official API framework

import { ClientMessage } from "../types.js";
/**
 * Text API object
 *
 * @group Text
 */
export declare class Text extends ClientMessage {
    /**
     * Body of the message. Maximum length: 4096 characters.
     */
    readonly body: string;
    /**
     * Whether to enable preview for the text message
     */
    readonly preview_url?: boolean;
    /**
     * @override
     * @internal
     */
    get _type(): "text";
    /**
     * Create a Text object for the API
     *
     * @example
     * ```ts
     * import { Text } from "whatsapp-api-js/messages";
     *
     * const text_message = new Text("Hello world!");
     *
     * const text_preview_message = new Text("Hello URL!", true);
     * ```
     *
     * @param body - The content of the text message which can contain formatting and URLs which begin with http:// or https://
     * @param preview_url - By default, WhatsApp recognizes URLs and makes them clickable, but you can also include a preview box with more information about the link. Set this field to true if you want to include a URL preview box.
     * @throws If body is over 4096 characters
     */
    constructor(body: string, preview_url?: boolean);
}
//# sourceMappingURL=text.d.ts.map