B2G/QA/WebAPI Test Plan/WebSMS

B2G WebSMS API Test Plan

Summary

Lead	Geo Mealer (irc: geo)
Contributors	TBD
API Description	Send/receive SMS messages as well as manage messages stored on device.
API Developer	Mounir Lamouri
API Project Page	WebSMS
API Tracking Bugs	bug 674725
API Status	Mostly done for B2G.

Scope

A short section should be added here that describes the testing scope of this plan: both what is and is not included, broadly.

Strategy

Explain here how to test the API in question (emulator, device-agnostic CI tests, on-device applications, or a combination).

In the likely case of a combination, discuss how tests will be split between options.

API

Describe the API here. Give a short summary, what the API does, and any considerations or preconditions for using it.

Related Prefs

• dom.sms.enabled
• dom.sms.whitelist

nsIDOMNavigatorSms : nsISupports

Attributes

• readonly nsIDOMMozSmsManager mozSms

nsIDOMSmsCursor : nsISupports

Attributes

• readonly nsIDOMMozSmsMessage message

Methods

• void continue()

nsIDOMSmsEvent : nsIDOMEvent

Attributes

• readonly nsIDOMMozSmsMessage message

nsIDOMSmsFilter : nsISupports

Attributes

• jsval startDate
  Date, can return null
• jsval endDate
  Date, can return null
• jsval numbers
  Array of DOMString, can return null
• DOMString delivery
  "sent", "received", or null
• jsval read
  Boolean, can be undefined

nsIDOMSmsManager : nsIDOMEventTarget

Methods

• unsigned short getNumberOfMessagesForText(in DOMString text)
• jsval send(in jsval number, in DOMString message)
  First param can be DOMString (one number) or Array of DOMString (multiple numbers).
  Returns either SmsRequest or array of SmsRequest accordingly.
• nsIDOMMozSmsRequest getMessage(in long id)
• nsIDOMMozSmsRequest delete(in jsval param)
  Param can be either message id or SmsMessage
• nsIDOMMozSmsRequest getMessages(in nsIDOMMozSmsFilter filter, in boolean reverse)
• nsIDOMMozSmsRequest markMessageRead(in long id, in boolean aValue)

Events

• onreceived
• onsent
• ondelivered

nsIDOMSmsMessage : nsISupports

Attributes

• readonly long id
• readonly DOMString delivery
  "sent" or "received"
• readonly DOMString sender
• readonly DOMString receiver
• readonly DOMString body>
• readonly jsval timestamp
  Date
• readonly boolean read

nsISomeInterface

Attributes

• readonly DOMString someAttribute
  values can be foo, bar, baz, bam

Methods

• boolean someMethod(in DOMString param)
• void anotherMethod()

Events

• onsomevent

Tests

Marionette/JS

Test Type 1

• Test 1
• Test 2

Test Type 2

• Test 1
• Test 2

mochitest-plain

Test Type 1

• Test 1
• Test 2

Test Type 2

• Test 1
• Test 2

Test App Design

Describe application functionality here

---

This page is based on the WebAPI Test Plan Template