-
Notifications
You must be signed in to change notification settings - Fork 18
/
Message.d.ts
63 lines (59 loc) · 1.67 KB
/
Message.d.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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/**
* # Message
*
* The Message object can be used to create and send mail iMessages, similar to those created by a "Message" action step.
* ### Examples
*
* ```javascript
* var msg = Message.create();
* msg.toRecipients = ["joe@sample.com"];
* msg.subject = "My test message";
* msg.body = "Body text";
*
* var success = msg.send();
* ```
*/
declare class Message {
/**
* Array of phone numbers and email addresses to use as `To:` recipients.
*/
toRecipients: string[]
/**
* Subject line. Only used if subject is enabled in Messages settings on the device.
*/
subject: string
/**
* Body text of the mail message.
*/
body: string
/**
* true/false flag indicated if the message object has already been sent.
*/
isSent: boolean
/**
* One of the following strings
* * created: Initial value before `send()` has been called.
* * sent: The message was sent successfully.
* * messagesUnavailable: On iOS, Mail.app services were not available.
* * userCancelled: The user cancelled the Mail.app window without sending.
* * unknownError: An unknown error occurred.
*/
status:
| 'created'
| 'sent'
| 'messagesUnavailable'
| 'userCancelled'
| 'unknownError'
/**
* Send the message. This will open the `Messages.app` sending window. Returns `true` if the message was sent successfully or `false` if not - if, for example, the user cancelled the message window.
*/
send(): boolean
/**
* Instantiate `Message` object
*/
static create(): Message
/**
* Create new instance.
*/
constructor()
}