|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-A957A1DF-AF81-5A9D-BB44-1B34B2EB809E" xml:lang="en"><title>GSM |
|
13 Utilities</title><shortdesc>This section describes the GSM utility classes and the functionality |
|
14 they provide in the SMS stack. . </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
15 <p>The GSM utility (GSMU) class provides the functionality specified in the |
|
16 3GPP standards <xref href=""http://www.3gpp.org/ftp/Specs/html-info/23038.htm".dita">23.038</xref> and<xref href=""http://www.3gpp.org/ftp/Specs/html-info/23040.htm".dita">23.040</xref>. </p> |
|
17 <section><title>Specialised SMS classes</title> <p>The GSMU provides a specialised |
|
18 SMS class called <xref href="GUID-CCF026F3-BB2F-383B-B15D-C73EC7DD81B3.dita"><apiname>TGsmuLex8</apiname></xref>. <xref href="GUID-757CA2F5-4FEF-3E7E-BD2F-3D3F87204A3C.dita"><apiname>TGsmulex8</apiname></xref> provides |
|
19 methods to decode the PDU data. </p> </section> |
|
20 <section><title>PDU element classes</title> <p>The following classes provide |
|
21 utility methods to encode and decode different elements of a PDU. </p> <table id="GUID-EE9BC649-3752-5BBD-88B8-D6E3C4B40CDC"> |
|
22 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
23 <thead> |
|
24 <row> |
|
25 <entry>GSMU Class</entry> |
|
26 <entry>Functionality </entry> |
|
27 </row> |
|
28 </thead> |
|
29 <tbody> |
|
30 <row> |
|
31 <entry><p> <xref href="GUID-BBF068E3-8DFA-3FD4-B24C-E71E781E0F33.dita"><apiname>TSmsOctet</apiname></xref> </p> </entry> |
|
32 <entry><p>Provides methods to encode and decode the octets of a PDU </p> </entry> |
|
33 </row> |
|
34 <row> |
|
35 <entry><p> <xref href="GUID-BF70A971-E569-3871-9137-D760EB9F4EF0.dita"><apiname>CSmsAlphabetConverter</apiname></xref> </p> </entry> |
|
36 <entry><p>Provides methods for character conversion between native type and |
|
37 user defined type. This class provides the functionality to compliment <xref href="GUID-F77B4E1E-66E6-327F-BCE2-3AEDC51BB430.dita"><apiname>CSmsBufferSegmenter</apiname></xref>, <xref href="GUID-A168BD0C-03AC-3342-B1FE-05969E05DEA8.dita"><apiname>TSmsBufferReassembler</apiname></xref> and <xref href="GUID-A6141B70-D1C0-3DFE-AE2A-BE096F81FC67.dita"><apiname>TSmsAlphabetPacker</apiname></xref>. </p> </entry> |
|
38 </row> |
|
39 <row> |
|
40 <entry><p> <xref href="GUID-B21EB26E-6CE5-3020-9A68-8BB4F18B4704.dita"><apiname>CSmsmAddress</apiname></xref> </p> </entry> |
|
41 <entry><p>Provides methods to represent the recipient device or the service |
|
42 centre address. </p> </entry> |
|
43 </row> |
|
44 <row> |
|
45 <entry><p> <xref href="GUID-53D31C79-A867-3D52-897B-AC8AD0934F8C.dita"><apiname>TGsmSmsTypeOfAddress</apiname></xref> </p> </entry> |
|
46 <entry><p>Provides methods to specify the type of address used. The type of |
|
47 address includes the details of the numbering plan indicator and the type |
|
48 of numbering used. </p> </entry> |
|
49 </row> |
|
50 <row> |
|
51 <entry><p> <xref href="GUID-2C2DD096-D132-3B40-86CE-FDE1FE268313.dita"><apiname>TGsmSmsTelNumber</apiname></xref> </p> </entry> |
|
52 <entry><p>Provides methods to encapsulate basic address information like source |
|
53 device address, destination address and the service centre address in a SMS |
|
54 message. </p> </entry> |
|
55 </row> |
|
56 <row> |
|
57 <entry><p> <xref href="GUID-7E31BDC4-24DF-3D35-9FB2-77AAC1AE40E8.dita"><apiname>TSmsServiceCenterTimeStamp</apiname></xref> </p> </entry> |
|
58 <entry><p>Provides methods to get and set the service centre time stamp in |
|
59 a SMS message. </p> </entry> |
|
60 </row> |
|
61 <row> |
|
62 <entry><p> <xref href="GUID-BCC14F20-C78D-3A16-8890-FAD22F261450.dita"><apiname>TSmsValidityPeriod</apiname></xref> </p> </entry> |
|
63 <entry><p>Provides methods to get and set the validity period in a PDU. </p> </entry> |
|
64 </row> |
|
65 <row> |
|
66 <entry><p> <xref href="GUID-B0511E77-85EC-3646-9081-834ACC42B7B7.dita"><apiname>TSmsStatus</apiname></xref> </p> </entry> |
|
67 <entry><p>Provides methods to get and set the SMS status in the <codeph>STATUS |
|
68 REPORT</codeph> PDU. </p> </entry> |
|
69 </row> |
|
70 <row> |
|
71 <entry><p> <xref href="GUID-41AEFEFA-1F94-3AC9-91C1-9BA4FD2D9FFB.dita"><apiname>TSmsParameterIndicator</apiname></xref> </p> </entry> |
|
72 <entry><p>Provides methods to get and set flags in the reports and <codeph>COMMAND</codeph> PDUs. |
|
73 The flags represent extension, user data, data coding scheme and protocol |
|
74 identifier. </p> </entry> |
|
75 </row> |
|
76 <row> |
|
77 <entry><p> <xref href="GUID-E9006834-1964-3F62-BB79-551888274C1E.dita"><apiname>TSmsProtocolIdentifier</apiname></xref> </p> </entry> |
|
78 <entry><p>Provides methods to get and set the protocol identifier. </p> </entry> |
|
79 </row> |
|
80 <row> |
|
81 <entry><p> <xref href="GUID-3503C5E1-1940-31EF-A401-4397D04544F3.dita"><apiname>TSmsCommandType</apiname></xref> </p> </entry> |
|
82 <entry><p>Provides methods to get and set the type of commands in a <codeph>COMMAND</codeph> PDU. </p> </entry> |
|
83 </row> |
|
84 <row> |
|
85 <entry><p> <xref href="GUID-C12D3DFA-773F-3A08-B477-FE9420DB6DE7.dita"><apiname>CSmsuserData</apiname></xref> </p> </entry> |
|
86 <entry><p>Provides methods to get and set user data elements from a PDU. </p> </entry> |
|
87 </row> |
|
88 <row> |
|
89 <entry><p> <xref href="GUID-1719BD77-DFB0-3E64-A2F1-8B5B4E0B8C2A.dita"><apiname>CSmsCommandData</apiname></xref> </p> </entry> |
|
90 <entry><p>Provides methods to get and set various information elements from |
|
91 a SMS command message. </p> </entry> |
|
92 </row> |
|
93 </tbody> |
|
94 </tgroup> |
|
95 </table> </section> |
|
96 <section><title>PDU classes</title> <p>The following classes provide methods |
|
97 to create and process the six types of messages <codeph>DELIVER, SUBMIT, DELIVER |
|
98 REPORT, SUBMIT REPORT, STATUS REPORT</codeph> and <codeph>COMMAND</codeph>. </p> <table id="GUID-9AFF41C0-C11D-5F4B-8E7F-637004AE983C"> |
|
99 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
100 <thead> |
|
101 <row> |
|
102 <entry>class</entry> |
|
103 <entry>Functionality</entry> |
|
104 </row> |
|
105 </thead> |
|
106 <tbody> |
|
107 <row> |
|
108 <entry><p> <xref href="GUID-7E49F0BC-75C7-3D65-9628-55572FD7005C.dita"><apiname>CSmsPDU</apiname></xref> </p> </entry> |
|
109 <entry><p>Provides generic interface to encode and decode all six types of |
|
110 PDUs. <xref href="GUID-7E49F0BC-75C7-3D65-9628-55572FD7005C.dita"><apiname>CSmsPDU</apiname></xref> provides the common functionalities to encode |
|
111 and decode different types of PDUs. For more information about the methods |
|
112 provided by this class see the reference documentation. </p> </entry> |
|
113 </row> |
|
114 <row> |
|
115 <entry><p> <xref href="GUID-A2DFAA2C-990B-3220-91AC-62963BD3759A.dita"><apiname>CSmsDeliver</apiname></xref> </p> </entry> |
|
116 <entry><p>Provides the methods to create a <codeph>DELIVER</codeph> PDU. </p> </entry> |
|
117 </row> |
|
118 <row> |
|
119 <entry><p> <xref href="GUID-7C2F135A-9204-38F2-85C0-BBA1708096EA.dita"><apiname>CSmsSubmit</apiname></xref> </p> </entry> |
|
120 <entry><p>Provides methods to create a <codeph>SUBMIT</codeph> PDU. </p> </entry> |
|
121 </row> |
|
122 <row> |
|
123 <entry><p> <xref href="GUID-45AC53BB-8671-3FAE-B217-8E4085DC8598.dita"><apiname>CSmsDeliverReport</apiname></xref> </p> </entry> |
|
124 <entry><p>Provides methods to create a <codeph>DELIVER REPORT</codeph> PDU. |
|
125 A DELIVER REPORT message is created to acknowledge a received SMS. </p> </entry> |
|
126 </row> |
|
127 <row> |
|
128 <entry><p> <xref href="GUID-05BDF012-354E-3513-8BB0-88D044B78901.dita"><apiname>CSmsSubmitReport</apiname></xref> </p> </entry> |
|
129 <entry><p>Provides methods to process a SUBMIT REPORT message sent by the |
|
130 network in response to a submit message. The SUBMIT REPORT contains the result |
|
131 of the SUBMIT message like if the message was submitted successfully, if not |
|
132 the reason for the failure. </p> </entry> |
|
133 </row> |
|
134 <row> |
|
135 <entry><p> <xref href="GUID-60DCC747-1ACE-305E-A4BA-F07C33A6B6CF.dita"><apiname>CSmsStatusReport</apiname></xref> </p> </entry> |
|
136 <entry><p>Provides the methods to process the STATUS REPORT message sent by |
|
137 the network. The message contains the details of the status of a previously |
|
138 sent SUBMIT message. </p> </entry> |
|
139 </row> |
|
140 <row> |
|
141 <entry><p> <xref href="GUID-AC19C0ED-1D6C-3A8D-995B-AC6965EF8A4B.dita"><apiname>CSmsCommand</apiname></xref> </p> </entry> |
|
142 <entry><p>Provides methods to create a COMMAND message. This message is mobile |
|
143 originated and sent to the network requesting some action like status of sent |
|
144 message. </p> </entry> |
|
145 </row> |
|
146 </tbody> |
|
147 </tgroup> |
|
148 </table> </section> |
|
149 <section><title>Buffer classes</title> <p>The GSMU provides the utility classes |
|
150 to store the SMS messages before segmentation and concatenation. <xref href="GUID-E6CDD68C-EBCF-3EEF-A17C-EF475B9868B7.dita"><apiname>CSmsBufferBase</apiname></xref> is |
|
151 the base class to create the buffer space in the memory. <xref href="GUID-6798011A-29D7-35AC-938E-B6E7E32CE539.dita"><apiname>CSmsBuffer</apiname></xref> is |
|
152 used to store an array of <xref href="GUID-317497AE-D70D-3FD5-9865-6446FF4AD035.dita"><apiname>TText</apiname></xref> in the memory. <xref href="GUID-0251B613-62C9-3C81-9E98-60C9ED3606AD.dita"><apiname>CSmsEditorBuffer</apiname></xref> class |
|
153 is used by the messaging server to store the text in <xref href="GUID-39945DA4-B362-3DF6-BF9E-DD079EEA7934.dita"><apiname>CRichText</apiname></xref> type. </p> </section> |
|
154 <section><title>User data settings</title> <p> <xref href="GUID-C1615364-719B-3BE2-93D2-562631EDCDAE.dita"><apiname>TSmsUserDataSettings</apiname></xref> class |
|
155 is used to encapsulate the settings such as character concatenation. The stored |
|
156 settings affect the encoding and decoding of the messages. </p> </section> |
|
157 <section><title>CSmsMessage</title> <p> <xref href="GUID-FA6D9B1B-3845-3B81-ACBB-34977D3C9631.dita"><apiname>CSmsMessage</apiname></xref> class |
|
158 is used to represent a complete message inside the SMS stack before segmentation |
|
159 and a complete message after reassembly. If the message type is class 0, incomplete |
|
160 messages are also stored by the <xref href="GUID-D7F28F6D-6D94-315D-A16C-25D54F80839F.dita"><apiname>CSmsMesasge</apiname></xref>. The complete |
|
161 message is stored in the <xref href="GUID-6798011A-29D7-35AC-938E-B6E7E32CE539.dita"><apiname>CSmsBuffer</apiname></xref>. The main function |
|
162 of the <xref href="GUID-FA6D9B1B-3845-3B81-ACBB-34977D3C9631.dita"><apiname>CSmsMessage</apiname></xref> is to store the information in a SMS |
|
163 and to encode and decode the message into different PDUs. The text in a message |
|
164 is accessed using <xref href="GUID-75FADA5A-569F-3654-902D-6E19BC906B50.dita"><apiname>Buffer()</apiname></xref> method. The <xref href="GUID-FA6D9B1B-3845-3B81-ACBB-34977D3C9631.dita"><apiname>CSmsMessage</apiname></xref> also |
|
165 supports decoding of partial complete Class 0 SMS. </p> <p>The CSmsMesasge |
|
166 class supports the following functionality: </p> <ul> |
|
167 <li id="GUID-077254B3-67CD-56BC-923C-3E81F97273A4"><p>To add hyperlink in |
|
168 a SMS message using <xref href="GUID-C57FBD33-73BA-3745-A7A3-BE806E0EFB64.dita"><apiname>CSmsHyperlinkOperations</apiname></xref> </p> </li> |
|
169 <li id="GUID-FD2DB455-1F53-5946-8C10-21BF4C18ED56"><p>To get and set the reply |
|
170 address path using <xref href="GUID-09486F51-9ABE-3E8B-8A88-101ECE33FB3E.dita"><apiname>CSmsReplyAddressOperations</apiname></xref> </p> </li> |
|
171 <li id="GUID-E23CB9C2-D3C2-55BA-8751-DAB1DF48B2E3"><p>To get, set and remove |
|
172 special message indicators using <xref href="GUID-7DCE58D9-C3E5-35A5-88BC-235869F36B39.dita"><apiname>CSmsSpecialMessageOperations</apiname></xref> </p> </li> |
|
173 <li id="GUID-95DC2E4B-58B8-55AB-824C-D97F2CEE0C6E"><p>To support the voice |
|
174 mail notifications. </p> </li> |
|
175 <li id="GUID-2E9C2992-CEEC-56BB-B249-BBE9EDF86370"><p> <xref href="GUID-54179AA6-3B34-3965-8CBC-3BA07E9A1C55.dita"><apiname>CSmsSMSCCtrlParameterOperations</apiname></xref> class |
|
176 provide the clients with methods to manipulate Short Message Service Centre |
|
177 (SMSC) control information elements. class </p> </li> |
|
178 <li id="GUID-F9086B00-F6D9-539E-BB8D-9F84B0991E4D"><p>To support segmentation |
|
179 and reassembly in the SMS stack. </p> </li> |
|
180 <li id="GUID-BBDA5B06-9EC4-5A8C-B03D-5359B9799E9A"><p>To pack and unpack data |
|
181 from the SMS messages. </p> </li> |
|
182 </ul> <p>The GSMU also provides the segmentation and reassembly |
|
183 store described in <xref href="GUID-B5BA3CB6-F2B8-524B-BF99-545AAE81549A.dita">SMS |
|
184 Stack Message Stores</xref>. </p> </section> |
|
185 </conbody></concept> |