@vonage/messages
Version:
Multi-channel messaging that integrates WhatsApp, Facebook, Viber, SMS, and MMS
53 lines • 1.6 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.MessengerFile = void 0;
const AbstractFileMessage_1 = require("../AbstractFileMessage");
const enums_1 = require("../../enums");
const MessageTypes_1 = require("../../enums/MessageTypes");
/**
* Represents a file message for the Messenger channel.
*
* @group Messenger
*/
class MessengerFile extends AbstractFileMessage_1.AbstractFileMessage {
/**
* The channel for this message (always 'messenger').
*/
channel = enums_1.Channels.MESSENGER;
/**
* The type of message (always 'file').
*/
messageType = MessageTypes_1.MessageTypes.FILE;
/**
* The messenger information for this message.
*/
messenger;
/**
* Sends a file message to the Facebook Messenger channel.
*
* @param {MessengerFileParams} params - The parameters for creating a Messenger file message.
*
* @example
* ```ts
* import { MessengerFile } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new MessengerFile({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* file: {
* url: 'https://example.com/image.jpg',
* caption: 'This is an image',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
constructor(params) {
super(params);
this.messenger = params.messenger;
}
}
exports.MessengerFile = MessengerFile;
//# sourceMappingURL=MessengerFile.js.map