|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="IAppManager.LaunchApp()"/><meta name="DC.Relation" scheme="URI" content="GUID-41FAD7DA-0DB7-48E7-BD60-58D6BFD785DA"/><meta name="DC.Relation" scheme="URI" content="GUID-4A2480A8-4D79-4F5D-9614-74A8934B8952"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-2D651505-F68C-4053-B565-9FF826C5B897"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-697AFF1F-24C7-43BD-A072-8352B3BE973C"/><title>IAppManager.LaunchApp() </title><script type="text/javascript"> |
|
5 function initPage() {} |
|
6 </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-697AFF1F-24C7-43BD-A072-8352B3BE973C"><span>IAppManager.</span>LaunchApp()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>LaunchApp</code> method launches an application based |
|
9 on a unique ID for the application (UID). It also provides a way to open a |
|
10 specific document (by specifying a document path), even if it is not the default |
|
11 file type for the application being launched.<span> For |
|
12 example, you can specify a path to a document with a <code>.txt</code> extension |
|
13 to open in WordPad, even though Notepad is the default application for .txt |
|
14 files.</span></p> |
|
15 <p>The application can be launched as chained (embedded) or stand-alone. |
|
16 For more information about embedded and stand-alone applications, see section <a href="GUID-E092BF10-C076-4476-9E80-87919940201B.html#GUID-E092BF10-C076-4476-9E80-87919940201B">Accessing and launching installed applications</a>.</p> |
|
17 <p>This method can be called both synchronously and asynchronously.</p> |
|
18 <p><strong>Syntax:</strong></p> |
|
19 <p>For synchronous calls:</p> |
|
20 <pre class="codeblock" id="GUID-21A6DD8A-D123-452E-9CD3-38987BE08CB2">result = so.IAppManager.LaunchApp(criteria);</pre> |
|
21 |
|
22 <p>For asynchronous calls:</p> |
|
23 <pre class="codeblock" id="GUID-07FA9E54-0E1E-4F9C-989D-2A9CF8E8C08F">result = so.IAppManager.LaunchApp(criteria, callback);</pre> |
|
24 |
|
25 <p><strong>Arguments:</strong></p> |
|
26 <ul> |
|
27 <li><p><code>criteria</code>:</p> |
|
28 |
|
29 <p>This is an object that specifies which application to launch. For more |
|
30 information about the object properties and how to define them, see section <a href="GUID-7DD6AB91-0582-4A46-9E19-2F12DC2FE674.html#GUID-7DD6AB91-0582-4A46-9E19-2F12DC2FE674">Criteria for launching an application</a>.</p> |
|
31 |
|
32 </li> |
|
33 <li><p><code>callback</code>:</p> |
|
34 |
|
35 <p>The <code>callback</code> argument is the name of the method |
|
36 that is executed when an asynchronous <code>LaunchApp</code> call |
|
37 has status information to return. You must define this method separately. |
|
38 Follow the instructions in section <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608">Defining the callback handler for an asynchronous method</a> to |
|
39 define the <code>callback</code> method.</p> |
|
40 <p>This argument is used only with an asynchronous <code>LaunchApp</code> call.</p> |
|
41 |
|
42 </li> |
|
43 </ul> |
|
44 <p><strong>Return value:</strong></p> |
|
45 <p>If synchronous, the <code>LaunchApp</code> method returns an |
|
46 object that contains an error code and an error message.</p> |
|
47 <div class="tablenoborder"><a name="GUID-8691DA0F-9EF0-443E-8AF5-F59A9AAD4E22"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-8691DA0F-9EF0-443E-8AF5-F59A9AAD4E22" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
48 properties for a synchronous LaunchApp</caption> |
|
49 <thead align="left"> |
|
50 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18274"> |
|
51 <p>Property</p> |
|
52 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18279"> |
|
53 <p>Description</p> |
|
54 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18284"> |
|
55 <p>Value</p> |
|
56 </th></tr> |
|
57 </thead> |
|
58 <tbody> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18274 "> |
|
61 <p><code>result.ErrorCode</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18279 "> |
|
64 <p>This is a number that specifies a predefined error code.</p> |
|
65 </td> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18284 "> |
|
67 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
68 </td> |
|
69 </tr> |
|
70 <tr class="bg "> |
|
71 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18274 "> |
|
72 <p><code>result.ErrorMessage</code></p> |
|
73 </td> |
|
74 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18279 "> |
|
75 <p>This is a text string that describes the error.</p> |
|
76 </td> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18284 "> |
|
78 <p>See <a href="GUID-50795090-A429-41CF-8CAA-EA2004D2643A.html#GUID-50795090-A429-41CF-8CAA-EA2004D2643A">AppManager Service API error messages</a>.</p> |
|
79 </td> |
|
80 </tr> |
|
81 </tbody> |
|
82 </table></div> |
|
83 <p>If asynchronous, the method returns an object that contains a transaction |
|
84 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
85 an error code, and an error message (see the following table). When the asynchronous |
|
86 call has completed, <code>callback</code> returns an |
|
87 object that contains an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table: Callback return value</a>).</p> |
|
88 <div class="note"><p><strong class="note_title">Note: </strong>If <a href="GUID-64CC3AB4-5444-474A-9470-818F423C5611.html#GUID-64CC3AB4-5444-474A-9470-818F423C5611"><code>Cancel</code></a> is |
|
89 called on an ongoing asynchronous request, <code>LaunchApp</code> will |
|
90 not return a notification when the launched application terminates.</p> |
|
91 </div> |
|
92 <div class="tablenoborder"><a name="GUID-7ED3652F-0708-4EE8-8ADA-CE759533676D"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-7ED3652F-0708-4EE8-8ADA-CE759533676D" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
93 properties for an asynchronous LaunchApp</caption> |
|
94 <thead align="left"> |
|
95 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18384"> |
|
96 <p>Property</p> |
|
97 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18389"> |
|
98 <p>Description</p> |
|
99 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e18394"> |
|
100 <p>Value</p> |
|
101 </th></tr> |
|
102 </thead> |
|
103 <tbody> |
|
104 <tr class=""> |
|
105 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18384 "> |
|
106 <p><code>result.TransactionID</code></p> |
|
107 </td> |
|
108 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18389 "> |
|
109 <p>This is a number used as an identification to match transactions started |
|
110 with the asynchronous <code>LaunchApp</code> call to one or more calls |
|
111 it generates to <code>callback</code>.</p> |
|
112 </td> |
|
113 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18394 "> </td> |
|
114 </tr> |
|
115 <tr class="bg "> |
|
116 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18384 "> |
|
117 <p><code>result.ErrorCode</code></p> |
|
118 </td> |
|
119 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18389 "> |
|
120 <p>This is a number that specifies a predefined error code.</p> |
|
121 </td> |
|
122 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18394 "> |
|
123 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
124 </td> |
|
125 </tr> |
|
126 <tr class=""> |
|
127 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18384 "> |
|
128 <p><code>result.ErrorMessage</code></p> |
|
129 </td> |
|
130 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18389 "> |
|
131 <p>This is a text string that describes the error.</p> |
|
132 </td> |
|
133 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e18394 "> |
|
134 <p>See <a href="GUID-50795090-A429-41CF-8CAA-EA2004D2643A.html#GUID-50795090-A429-41CF-8CAA-EA2004D2643A">AppManager Service API error messages</a>.</p> |
|
135 </td> |
|
136 </tr> |
|
137 </tbody> |
|
138 </table></div> |
|
139 <p><strong>Remarks:</strong></p> |
|
140 <p>Use the <a href="GUID-4A2480A8-4D79-4F5D-9614-74A8934B8952.html#GUID-4A2480A8-4D79-4F5D-9614-74A8934B8952"><code>GetList</code></a> method |
|
141 to retrieve the unique ID of the application to launch.</p> |
|
142 <p><strong>Example code:</strong></p> |
|
143 <p/> |
|
144 <p>For the complete source of a sample widget |
|
145 that demonstrates how to use this Service API, see <a href="GUID-2D47E7D9-199D-4D59-BD6A-592FA9F8B16A.html#GUID-2D47E7D9-199D-4D59-BD6A-592FA9F8B16A">the |
|
146 full example</a>.</p> |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |