B2G/QA/WebAPI Test Plan/WebSMS: Difference between revisions

From MozillaWiki
< B2G‎ | QA‎ | WebAPI Test Plan
Jump to navigation Jump to search
Line 44: Line 44:
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMNavigatorSms.idl nsIDOMNavigatorSms] : nsISupports ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMNavigatorSms.idl nsIDOMNavigatorSms] : nsISupports ===
==== Attributes ====
==== Attributes ====
* ''readonly'' <tt>nsIDOMMozSmsManager mozSms</tt>
* <tt>readonly nsIDOMMozSmsManager mozSms</tt>


=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsCursor.idl nsIDOMSmsCursor] : nsISupports ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsCursor.idl nsIDOMSmsCursor] : nsISupports ===
==== Attributes ====
==== Attributes ====
* ''readonly'' <tt>nsIDOMMozSmsMessage message</tt>
* <tt>readonly nsIDOMMozSmsMessage message</tt>


==== Methods ====
==== Methods ====
Line 55: Line 55:
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsEvent.idl nsIDOMSmsEvent] : nsIDOMEvent ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsEvent.idl nsIDOMSmsEvent] : nsIDOMEvent ===
==== Attributes ====
==== Attributes ====
* ''readonly'' <tt>nsIDOMMozSmsMessage message</tt>
* <tt>readonly nsIDOMMozSmsMessage message</tt>


=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsFilter.idl nsIDOMSmsFilter] : nsISupports ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsFilter.idl nsIDOMSmsFilter] : nsISupports ===
==== Attributes ====
==== Attributes ====
* <tt>jsval startDate</tt><br>Date, can return null
* <tt>jsval startDate</tt><br><small>Date, can return null</small>
* <tt>jsval endDate</tt><br>Date, can return null
* <tt>jsval endDate</tt><br><small>Date, can return null</small>
* <tt>jsval numbers</tt><br>Array of DOMString, can return null
* <tt>jsval numbers</tt><br><small>Array of DOMString, can return null</small>
* <tt>DOMString delivery</tt><br>"sent", "received", or null
* <tt>DOMString delivery</tt><br><small>"sent", "received", or null</small>
* <tt>jsval read</tt><br>Boolean, can be undefined
* <tt>jsval read</tt><br><small>Boolean, can be undefined</small>


=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsManager.idl nsIDOMSmsManager] : nsIDOMEventTarget ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsManager.idl nsIDOMSmsManager] : nsIDOMEventTarget ===
==== Methods ====
==== Methods ====
* <tt>unsigned short getNumberOfMessagesForText(in DOMString text)</tt>
* <tt>unsigned short getNumberOfMessagesForText(in DOMString text)</tt>
* <tt>jsval send(in jsval number, in DOMString message)</tt><br>First param can be DOMString (one number) or Array of DOMString (multiple numbers). Returns either SmsRequest or array of SmsRequest accordingly.
* <tt>jsval send(in jsval number, in DOMString message)</tt><br><small>First param can be DOMString (one number) or Array of DOMString (multiple numbers). Returns either SmsRequest or array of SmsRequest accordingly.</small>
* <tt>nsIDOMMozSmsRequest getMessage(in long id)</tt>
* <tt>nsIDOMMozSmsRequest getMessage(in long id)</tt>
* <tt>nsIDOMMozSmsRequest delete(in jsval param)</tt><br>Param can be either message id or SmsMessage
* <tt>nsIDOMMozSmsRequest delete(in jsval param)</tt><br><small>Param can be either message id or SmsMessage</small>
* <tt>nsIDOMMozSmsRequest getMessages(in nsIDOMMozSmsFilter filter, in boolean reverse)</tt>
* <tt>nsIDOMMozSmsRequest getMessages(in nsIDOMMozSmsFilter filter, in boolean reverse)</tt>
* <tt>nsIDOMMozSmsRequest markMessageRead(in long id, in boolean aValue)</tt>
* <tt>nsIDOMMozSmsRequest markMessageRead(in long id, in boolean aValue)</tt>
Line 81: Line 81:
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsMessage.idl nsIDOMSmsMessage] : nsISupports ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsMessage.idl nsIDOMSmsMessage] : nsISupports ===
==== Attributes ====
==== Attributes ====
* ''readonly'' <tt>long id</tt>
* <tt>readonly long id</tt>
* ''readonly'' <tt>DOMString delivery</tt><br>"sent" or "received"
* <tt>readonly DOMString delivery</tt><br><small>"sent" or "received"</small>
* ''readonly'' <tt>DOMString sender</tt>
* <tt>readonly DOMString sender</tt>
* ''readonly'' <tt>DOMString receiver</tt>
* <tt>readonly DOMString receiver</tt>
* ''readonly'' <tt>DOMString body></tt>
* <tt>readonly DOMString body></tt>
* ''readonly'' <tt>jsval timestamp</tt><br>Date
* <tt>readonly jsval timestamp</tt><br><small>Date</small>
* ''readonly'' <tt>boolean read</tt>
* <tt>readonly boolean read</tt>


=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsRequest.idl nsIDOMSmsRequest] : nsIDOMDOMRequest ===
=== [http://mxr.mozilla.org/mozilla-central/source/dom/sms/interfaces/nsIDOMSmsRequest.idl nsIDOMSmsRequest] : nsIDOMDOMRequest ===
Line 93: Line 93:
=== [http://mxr.mozilla.org/mozilla-central/source/nsISomeInterface.idl#1 nsISomeInterface] ===
=== [http://mxr.mozilla.org/mozilla-central/source/nsISomeInterface.idl#1 nsISomeInterface] ===
==== Attributes ====
==== Attributes ====
* ''readonly'' <tt>DOMString someAttribute</tt> (values can be foo, bar, baz, bam)
* <tt>readonly DOMString someAttribute</tt><br><small>values can be foo, bar, baz, bam</small>


==== Methods ====
==== Methods ====

Revision as of 01:05, 27 June 2012

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

nsIDOMSmsRequest : nsIDOMDOMRequest

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

Retrieved from "https://wiki.allizom.org/index.php?title=B2G/QA/WebAPI_Test_Plan/WebSMS&oldid=445850"