mozilla

Compare Revisions

Notifications.jsm

Change Revisions

Revision 485875:

Revision 485875 by wesj on

Revision 485877:

Revision 485877 by wesj on

Title:
Notifications.jsm
Notifications.jsm
Slug:
Extensions/Mobile/API/Notifications.jsm
Extensions/Mobile/API/Notifications.jsm
Content:

Revision 485875
Revision 485877
nn147            <tr>
148              <td></td>
149            </tr>
n161void update(inid, Object options)n164void update(String guid, Object options)
n171        The id of the notification to updaten174        The guid of the notification to update
nn244            <tr>
245              <td></td>
246            </tr>
n252      Get an array of App objects that can handle this protocol.n258      Remove a notification from the system bar
n255App[] getAppsForProtocol(protocol);n261void cancel(String guid);
n261      Takes a string protocoln267      Takes a guid
262    </p>
263    <h4 id="Return_value" name="Return_value">
264      Return value
265    </h4>
266    <p>
267      Returns an array of App objects. Array will be length zero 
>if none are found. 
t272    <pre>t
273let httpHandlers = getAppsForProtocol("http");
274alert("Http links can be opened with " + httpHandlers[0].name);
275</pre>
276    <h3 id="getAppsForUri" name="getAppsForUri">
277      HelperApps.getAppsForUri()
278    </h3>
279    <p>
280      Gets a list of App objects that are registered to open a pa
>rticular uri 
281    </p>
282    <pre class="eval">
283App[] getAppsForUri(uri, flags = { filterHttp: true })
284</pre>
285    <h4 id="Parameters" name="Parameters">
286      Parameters
287    </h4>
288    <dl>
289      <dt>
290        uri
291      </dt>
292      <dd>
293        The nsIUri of the page
294      </dd>
295      <dt>
296        flags
297      </dt>
298      <dd>
299        A set of flags to control the filter
300      </dd>
301    </dl>
302    <table class="standard-table">
303      <tbody>
304        <tr>
305          <td class="header">
306            Flag
307          </td>
308          <td class="header">
309            Description
310          </td>
311        </tr>
312        <tr>
313          <td>
314            <code>filterHttp</code>
315          </td>
316          <td>
317            Should http handlers be filtered from the results. De
>faults to true 
318          </td>
319        </tr>
320        <tr>
321          <td>
322            <code>action</code>
323          </td>
324          <td>
325            The <a href="http://developer.android.com/reference/a
>ndroid/content/Intent.html">Android Intent</a> <a href="http://de 
>veloper.android.com/reference/android/content/Intent.html">action 
></a> to use when filtering. Defaults to <a href="http://developer 
>.android.com/reference/android/content/Intent.html#ACTION_VIEW">I 
>ntent.ACTION_VIEW</a> 
326          </td>
327        </tr>
328        <tr>
329          <td>
330            <code>packageName</code>
331          </td>
332          <td>
333            The <a href="http://developer.android.com/guide/topic
>s/manifest/manifest-element.html#package">Android packageName</a> 
> to use when filtering. Use if you want to find a particular app. 
334          </td>
335        </tr>
336        <tr>
337          <td>
338            <code>mimeType</code>
339          </td>
340          <td>
341            The mimetype of the uri. If not provided, the impleme
>ntation will try to guess a mimetype from the <a href="/en-US/doc 
>s/XPCOM_Interface_Reference/nsIURI">nsIURI</a>. If this is overri 
>dden, you don't even have to provide a uri to search for, and can 
> instead search for handlers of a particular mimetype. 
342          </td>
343        </tr>
344      </tbody>
345    </table>
346    <h4 id="Return_value" name="Return_value">
347      Return value
348    </h4>
349    <p>
350      Returns a list of App objects that are registered to open a
> particular uri 
351    </p>
352    <h4 id="Example" name="Example">
353      Example
354    </h4>
355    <pre>
356let url = "http://www.foo.com/myfile.dat";
357let apps = HelperApps.getAppsForUri(Services.io.newUri(url, null,
> null), { mimeType: "foo/bar" }); 
358alert(url + " can be opened with " + httpHandlers[0].name);
359</pre>
360    <h3 id="launchUri" name="launchUri">
361      HelperApps.launchUri()
362    </h3>
363    <p>
364      Sends an <a href="/en-US/docs/XPCOM_Interface_Reference/nsI
>URI">nsIURI</a> as an intent to the Android system. This may show 
> an Android native Intent chooser if multiple apps are available  
>(and none are marked as default). 
365    </p>
366    <pre class="eval">
367void launchUri(<a href="/en-US/docs/XPCOM_Interface_Reference/nsI
>URI">nsIURI</a> uri); 
368</pre>
369    <h4 id="Parameters" name="Parameters">
370      Parameters
371    </h4>
372    <p>
373      Takes an <a href="/en-US/docs/XPCOM_Interface_Reference/nsI
>URI">nsIURI</a> to launch. 
374    </p>
375    <h4 id="Return_value" name="Return_value">
376      Return value
377    </h4>
378    <p>
379      None
380    </p>
381    <h4 id="Example" name="Example">
382      Example
383    </h4>
384    <pre>
385HelperApps.launchUri(Services.io.newUri("http://www.google.com", 
>null, null)); 
386</pre>

Back to History