Used to send SMS text messages for the WebSMS API
1.0
49
Introduced
Gecko 13.0
Inherits from:
nsISupports
Last changed in Gecko 15.0 (Firefox 15.0 / Thunderbird 15.0 / SeaMonkey 2.12)Implemented by: @mozilla.org/sms/smsservice;1
. To create an instance, use:
var smsService = Components.classes["@mozilla.org/sms/smsservice;1"] .createInstance(Components.interfaces.nsISmsService);
Method overview
[implicit_jscontext] nsIDOMMozSmsMessage createSmsMessage(in long id, in DOMString delivery, in DOMString sender, in DOMString receiver, in DOMString body, in jsval timestamp, in bool read ); |
unsigned short getNumberOfMessagesForText(in DOMString text); |
boolean hasSupport(); |
void send(in DOMString number, in DOMString message, in long requestId, [optional] in unsigned long long processId); |
Methods
createSmsMessage()
[implicit_jscontext] nsIDOMMozSmsMessage createSmsMessage( in long id, in DOMString delivery, in DOMString sender, in DOMString receiver, in DOMString body, in jsval timestamp, in bool read );
Parameters
id
- A number representing the id of the message.
delivery
- A
DOMString
which can either be "received" or "sent" and is representing the way the SMS was delivered. sender
- A
DOMString
with the name of the sender. receiver
- A
DOMString
with the name of the receiver. body
- A
DOMString
with the text of the message. timestamp
- A
Date
object with the timestamp of the message. read
- A Boolean indicating whether a message is marked as read or unread.
Return value
getNumberOfMessagesForText()
unsigned short getNumberOfMessagesForText( in DOMString text );
Parameters
text
- A
DOMString
text to check.
Return value
The number of multi-part SMS needed for a given text (160 characters for one SMS).
hasSupport()
Checks if the current platform has SMS support.
boolean hasSupport();
Return value
Boolean.
send()
void send(
in DOMString number,
in DOMString message,
in long requestId,
in unsigned long long processId Optional
);
Parameters
number
- A
DOMString
with a telephone number to send to. message
- A
DOMString
with the text message. requestId
- Missing Description
processId
Optional- Missing Description