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

A TypeScript server agnostic Whatsapp's Official API framework

import { ClientMessage } from "../types.js";
/**
 * Location API component
 *
 * @group Location
 */
export declare class Location extends ClientMessage {
    /**
     * The latitude of the location
     */
    readonly longitude: number;
    /**
     * The longitude of the location
     */
    readonly latitude: number;
    /**
     * The name of the location
     */
    readonly name?: string;
    /**
     * The address of the location
     */
    readonly address?: string;
    /**
     * @override
     * @internal
     */
    get _type(): "location";
    /**
     * Create a Location object for the API
     *
     * @example
     * ```ts
     * import { Location } from "whatsapp-api-js/messages";
     *
     * const location_message = new Location(0, 0);
     *
     * const location_named_message = new Location(0, 0, "My Store", "Address");
     * ```
     *
     * @param longitude - Longitude of the location
     * @param latitude - Latitude of the location
     * @param name - Name of the location
     * @param address - Address of the location, only displayed if name is present
     */
    constructor(longitude: number, latitude: number, name?: string, address?: string);
}
//# sourceMappingURL=location.d.ts.map