|
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="IMessaging.Send()"/><meta name="DC.Relation" scheme="URI" content="GUID-DFEDF3BF-BA73-4418-815C-83B80B888821"/><meta name="DC.Relation" scheme="URI" content="GUID-C12C81D1-13A4-4B8C-81B9-694D414A4A48"/><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-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB"/><title>IMessaging.Send() </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-5295F092-004B-43F4-85DB-7C54ED14D6DB"><span>IMessaging.</span>Send()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Send</code> method sends an SMS or MMS message.</p> |
|
9 <p>This method can be called both synchronously and asynchronously.</p> |
|
10 <p><strong>Syntax:</strong></p> |
|
11 <p>For synchronous calls:</p> |
|
12 <pre class="codeblock" id="GUID-0A45190E-1AD2-4CA0-9808-7192ABEFF3AC">result = so.IMessaging.Send(criteria);</pre> |
|
13 |
|
14 <p>For asynchronous calls:</p> |
|
15 <pre class="codeblock" id="GUID-1B239649-3C04-4E43-86B1-4EBEC2EA1045">result = so.IMessaging.Send(criteria, callback);</pre> |
|
16 |
|
17 <p><strong>Arguments:</strong></p> |
|
18 <ul> |
|
19 <li><p><code>criteria</code>:</p> |
|
20 |
|
21 <p>This is an object that specifies the type and details of the message |
|
22 to send. For more information about the object properties and how to define |
|
23 them, see section <a href="GUID-1A98E402-3609-4E83-A86C-98AB37025A47.html#GUID-1A98E402-3609-4E83-A86C-98AB37025A47">Criteria for sending a message</a>.</p> |
|
24 |
|
25 </li> |
|
26 <li><p><code>callback</code>:</p> |
|
27 |
|
28 <p>The <code>callback</code> argument is the name of the method |
|
29 that is executed when an asynchronous <code>Send</code> call has status |
|
30 information to return. You must define this method separately. Follow the |
|
31 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 |
|
32 define the <code>callback</code> method.</p> |
|
33 <p>This argument is used only with an asynchronous <code>Send</code> call.</p> |
|
34 |
|
35 </li> |
|
36 </ul> |
|
37 <p><strong>Return value:</strong></p> |
|
38 <p>If synchronous, the <code>Send</code> method returns an object |
|
39 that contains an error code and an error message.</p> |
|
40 <p>If asynchronous, the method returns an object that contains a transaction |
|
41 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
42 an error code, and an error message (see the following table). When the asynchronous |
|
43 call has completed, <code>callback</code> returns an object that contains |
|
44 an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table: |
|
45 Callback return value</a>).</p> |
|
46 <div class="tablenoborder"><a name="GUID-1A7A6218-106F-4490-9FFA-0A1F5216D529"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-1A7A6218-106F-4490-9FFA-0A1F5216D529" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
47 properties for Send</caption> |
|
48 |
|
49 <thead align="left"> |
|
50 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e59584"> |
|
51 <p>Property</p> |
|
52 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e59589"> |
|
53 <p>Description</p> |
|
54 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e59594"> |
|
55 <p>Value</p> |
|
56 </th></tr> |
|
57 </thead> |
|
58 <tbody> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59584 "> |
|
61 <p><code>result.ReturnValue</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59589 "> |
|
64 <p>This is a number used as an identification to match transactions started |
|
65 with an asynchronous <code>Send</code> call to one or more calls it |
|
66 generates to <code>callback</code>.</p> |
|
67 <p>This property is only valid for asynchronous calls.</p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59594 "> </td> |
|
70 </tr> |
|
71 <tr class="bg "> |
|
72 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59584 "> |
|
73 <p><code>result.ErrorCode</code></p> |
|
74 </td> |
|
75 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59589 "> |
|
76 <p>This is a number that specifies a predefined error code.</p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59594 "> |
|
79 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
80 </td> |
|
81 </tr> |
|
82 <tr class=""> |
|
83 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59584 "> |
|
84 <p><code>result.ErrorMessage</code></p> |
|
85 </td> |
|
86 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59589 "> |
|
87 <p>This is a text string that describes the error.</p> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e59594 "> |
|
90 <p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p> |
|
91 </td> |
|
92 </tr> |
|
93 </tbody> |
|
94 </table></div> |
|
95 <p><strong>Remarks:</strong></p> |
|
96 <p>Apart from status information and transaction IDs for asynchronous calls, |
|
97 the <code>Send</code> method does not return any result information.</p> |
|
98 <p><strong>Example code:</strong></p> |
|
99 <p/> |
|
100 <p>For the complete source of a sample widget |
|
101 that demonstrates how to use this Service API, see <a href="GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B.html#GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B">the full example</a>.</p> |
|
102 |
|
103 |
|
104 |
|
105 |
|
106 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |