-
Notifications
You must be signed in to change notification settings - Fork 180
/
WhatsAppFile.ts
44 lines (41 loc) · 1.09 KB
/
WhatsAppFile.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import { Channels } from '../../enums';
import { AbstractFileMessage } from '../AbstractFileMessage';
import { WhatsAppFileParams, WhatsAppContext } from '../../types';
/**
* Represents a file message for WhatsApp.
*
* @group WhatsApp
*/
export class WhatsAppFile
extends AbstractFileMessage
implements WhatsAppFileParams
{
public channel = Channels.WHATSAPP;
public context?: WhatsAppContext;
/**
* Send a WhatsApp file message.
*
* @param {WhatsAppFileParams} params - The parameters for creating a WhatsApp file message.
* @example
* ```ts
* import { WhatsAppFile } from '@vonage/messages';
*
* const { messageUUID } = await messagesClient.send(new WhatsAppFile({
* to: TO_NUMBER,
* from: FROM_NUMBER,
* file: {
* url: 'https://example.com/image.jpg',
* },
* clientRef: 'my-personal-reference',
* }));
*
* console.log(`Message sent successfully with UUID ${messageUUID}`);
* ```
*/
public constructor(params: WhatsAppFileParams) {
super(params);
if (params.context) {
this.context = params.context;
}
}
}