|
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-1F7B0EB9-50E9-4C11-B620-18054596F5AD" xml:lang="en"><title>Deprecated APIs</title><shortdesc>All the deprecated APIs in Symbian^3 are listed with the |
|
13 alternatives provided. These deprecated APIs will be removed from |
|
14 the future Symbian platform release, so it is recommended to avoid |
|
15 using these APIs.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
16 <p>The following table summarizes the deprecated APIs:</p> |
|
17 <table id="GUID-1A133A2D-D803-4026-AF28-4A96DB25F42B-GENID-1-6-1-1-6-1-4-1-3-2"> |
|
18 <tgroup cols="3"><colspec colname="col1" colwidth="0.34*"/><colspec colname="COLSPEC0" colwidth="1.66*"/><colspec colname="col2" colwidth="1.66*"/> |
|
19 <thead> |
|
20 <row> |
|
21 <entry>API</entry> |
|
22 <entry>Affected headers and libraries</entry> |
|
23 <entry>Description</entry> |
|
24 </row> |
|
25 </thead> |
|
26 <tbody> |
|
27 <row> |
|
28 <entry>AVKON UI framework and the following dependant APIs:<ul> |
|
29 <li><p>Phonebook Data Add Edit UI API</p></li> |
|
30 <li><p>Phonebook Data Management API</p></li> |
|
31 <li><p>Speed Dial Utility Control API</p></li> |
|
32 <li><p>Phonebook vCard Import Export API</p></li> |
|
33 <li><p>Phonebook UI Utilities API</p></li> |
|
34 <li><p>Phonebook Thumbnail operation API</p></li> |
|
35 <li><p>Phonebook Fetch UI API</p></li> |
|
36 <li><p>Screensaver API</p></li> |
|
37 <li><p>SendUI API</p></li> |
|
38 <li><p>Notepad Library API</p></li> |
|
39 <li><p>Connection Settings UI API</p></li> |
|
40 <li><p>Landmarks UI Add_Edit API</p></li> |
|
41 <li><p>Landmarks UI selector API</p></li> |
|
42 <li><p>Location Center Registration API</p></li> |
|
43 </ul></entry> |
|
44 <entry>The <filepath>avkon.lib</filepath>, <filepath>commondialogs.lib</filepath>, and <filepath>eikcoctl.lib</filepath> libraries of AVKON UI framework |
|
45 are affected by this change.<p>The following dependant libraries are |
|
46 also affected by this change:</p><ul> |
|
47 <li><p><filepath>pbkview.lib</filepath></p></li> |
|
48 <li><p><filepath>pbkeng.lib</filepath></p></li> |
|
49 <li><p><filepath>bcardeng.lib</filepath></p></li> |
|
50 <li><p><filepath>spdctrl.lib</filepath></p></li> |
|
51 <li><p><filepath>sendui.lib</filepath></p></li> |
|
52 <li><p><filepath>npdlib.lib</filepath></p></li> |
|
53 <li><p><filepath>cmmanager.lib</filepath></p></li> |
|
54 <li><p><filepath>eikdlg.lib</filepath></p></li> |
|
55 <li><p><filepath>commonui.lib</filepath></p></li> |
|
56 <li><p><filepath>eikctl.lib</filepath></p></li> |
|
57 <li><p><filepath>uiklaf.lib</filepath></p></li> |
|
58 <li><p><filepath>eikdlg.lib</filepath></p></li> |
|
59 <li><p><filepath>aknnotify.lib</filepath></p></li> |
|
60 <li><p><filepath>lmkcommonui.lib</filepath></p></li> |
|
61 </ul></entry> |
|
62 <entry>AVKON UI framework and its dependant APIs have been deprecated. |
|
63 This is the first step to move to Qt UI framework in the future releases. |
|
64 It is recommended to start migrating all the existing applications |
|
65 from AVKON to Qt, so that these applications continue to work on the |
|
66 future Symbian platform releases. For more information on migrating |
|
67 to Qt, refer to <xref format="html" href="http://library.forum.nokia.com/topic/Qt_for_Symbian_Developers_Library/GUID-97A34C6E-9F2B-4743-86F8-563362F7047A_cover.html" scope="external">Qt for Symbian</xref></entry> |
|
68 </row> |
|
69 <row> |
|
70 <entry><codeph>KLinkLayerOpen</codeph> and <codeph>KLinkLayerClosed</codeph> </entry> |
|
71 <entry><filepath>nifvar.h</filepath> and <filepath>nifman.dll</filepath></entry> |
|
72 <entry>These constants have been deprecated. The existing applications |
|
73 will continue to work, but it is recommended that the new applications |
|
74 use<codeph> KConnectionUp</codeph> or <codeph>KConnectionDown</codeph> constants (<filepath>es_sock.h</filepath>) to indicate the connection |
|
75 status.</entry> |
|
76 </row> |
|
77 <row> |
|
78 <entry><codeph>KCDCurrentVersion</codeph> and <codeph>KCDLatestVersion</codeph> </entry> |
|
79 <entry><filepath>commsdat.h</filepath>, <filepath>metadatabase.h</filepath> and <filepath>commsdat.dll</filepath>.</entry> |
|
80 <entry>These constants were used to retrieve the version information |
|
81 of a database schema in Comms Database. They have been deprecated |
|
82 from Symbian^3 onwards as there are two database schemas in Comms |
|
83 Database. To identify each of these schemas separately, use <codeph>KCDVersion1_1</codeph> and <codeph>KCDVersion1_2</codeph> instead |
|
84 of the deprecated constants. The existing applications using these |
|
85 deprecated constants will continue to work on Symbian^3 without any |
|
86 change.</entry> |
|
87 </row> |
|
88 <row> |
|
89 <entry><codeph>RConnection::DataTransferredRequest()</codeph>, <codeph>RConnection::DataTransferredCancel()</codeph>, <codeph>RConnection::GetDataSentNotificationRequest()</codeph>, <codeph>RConnection::DataSentNotificationCancel()</codeph>, <codeph>RConnection::DataReceivedNotificationRequest()</codeph>, and <codeph>RConnection::DataReceivedNotificationCancel()</codeph>.</entry> |
|
90 <entry><filepath>es_sock.h</filepath> and <filepath>esock.dll</filepath></entry> |
|
91 <entry>All these APIs has been deprecated. To monitor data and handle |
|
92 data sent/received notifications, use the <xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita"><apiname>RSubConnection</apiname></xref> API instead. All the existing applications continue to work on Symbian^3 |
|
93 without any changes. For more information on using <xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita"><apiname>RSubConnection</apiname></xref> API, refer to <xref href="GUID-61E0CD76-A2E3-5066-84A8-146EECA8ADCD.dita">Socket-Server</xref> documentation.</entry> |
|
94 </row> |
|
95 <row> |
|
96 <entry><p>Sub-connection management and monitoring APIs:</p><ul> |
|
97 <li><p><codeph>RConnection::Stop(TSubConnectionUniqueId)</codeph></p></li> |
|
98 <li><p><codeph>RConnection::Stop(TSubConnectionUniqueId, TConnStopType)</codeph> </p></li> |
|
99 <li><p><codeph>RConnection::ProgressNotification(TSubConnectionUniqueId, |
|
100 TNifProgressBuf&, TRequestStatus&, TUint)</codeph></p></li> |
|
101 <li><p><codeph>RConnection::CancelProgressNotification(TSubConnectionUniqueId)</codeph></p></li> |
|
102 <li><p><codeph>RConnection::Progress(TSubConnectionUniqueId, TNifProgress&) </codeph></p></li> |
|
103 <li><p><codeph>RConnection::IsSubConnectionActiveRequest()</codeph></p></li> |
|
104 <li><p><codeph>RConnection::IsSubConnectionActiveCancel()</codeph></p></li> |
|
105 </ul><p>Connection settings access APIs in RConnection:</p><ul> |
|
106 <li><p><codeph>RConnection::GetIntSetting(const TDesC&, TUint32&)</codeph></p></li> |
|
107 <li><p><codeph>RConnection::GetBoolSetting(const TDesC&, TBool&)</codeph></p></li> |
|
108 <li><p><codeph>RConnection::GetDesSetting(const TDesC&, TDes8&)</codeph></p></li> |
|
109 <li><p><codeph>RConnection::GetDesSetting(const TDesC&, TDes16&)</codeph></p></li> |
|
110 <li><p><codeph>RConnection::GetLongDesSetting(const TDesC& aSettingName, |
|
111 TDes& aValue)</codeph></p></li> |
|
112 </ul><p>System wide connection management and monitoring APIs:</p><ul> |
|
113 <li><p><codeph>RConnection::EnumerateConnections(TUint& aCount)</codeph></p></li> |
|
114 <li><p><codeph>RConnection::AllInterfaceNotification(TDes8& aNotification, |
|
115 TRequestStatus& aStatus)</codeph></p></li> |
|
116 <li><p><codeph>RConnection::CancelAllInterfaceNotification()</codeph></p></li> |
|
117 </ul></entry> |
|
118 <entry><filepath>es_sock.h</filepath> and <filepath>esocksvr.dll</filepath></entry> |
|
119 <entry><p>All the sub-connection management and monitoring APIs in |
|
120 RConnection have been deprecated. Instead of these deprecated APIs, |
|
121 use the following RSubConnection APIs:</p><ul> |
|
122 <li><p><xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita#GUID-0AFDA357-EE44-3788-9CAB-162B874134BF/GUID-7B2223D7-D08E-39D3-AF14-A15E848D1011"><apiname>RSubConnection::EventNotification(TNotificationEventBuf& |
|
123 aEventBuffer, TBool aGenericEventsOnly, TRequestStatus& aStatus)</apiname></xref> </p></li> |
|
124 <li><p><xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita#GUID-0AFDA357-EE44-3788-9CAB-162B874134BF/GUID-8894D416-34DA-32F9-9CAB-095A0039D6CD"><apiname>RSubConnection::EventNotification(TNotificationEventBuf& |
|
125 aEventBuffer, TEventFilter aEventFilterList[], TUint aEventListLength, |
|
126 TRequestStatus& aStatus)</apiname></xref></p></li> |
|
127 <li><p><xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita#GUID-0AFDA357-EE44-3788-9CAB-162B874134BF/GUID-ADCDEFFC-8622-3C77-91F0-2E3020745E46"><apiname>RSubConnection::CancelEventNotification()</apiname></xref></p></li> |
|
128 <li><p><xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita#GUID-0AFDA357-EE44-3788-9CAB-162B874134BF/GUID-E25294DA-633B-37BC-9921-09C4822C3B7A"><apiname>RSubConnection::Stop()</apiname></xref></p></li> |
|
129 </ul><p>For more information on these <xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita"><apiname>RSubConnection</apiname></xref> APIs, refer to <xref href="GUID-4C7ABD1C-B42C-590A-AD24-7FA6C3A8D18C.dita">Registering for Sub-Connection events: Tutorial</xref></p><p>The |
|
130 connection settings access APIs in <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita"><apiname>RConnection</apiname></xref> are |
|
131 deprecated so you can use <xref href="GUID-5EC4B812-241B-39BF-B74D-F72260C939BE.dita#GUID-5EC4B812-241B-39BF-B74D-F72260C939BE/GUID-546B08D6-2265-3BA7-9AAF-CF39E8ABCB6F"><apiname>RConnection::GetParameters(ESock::CCommsDataObjectBase& |
|
132 aDataObject)</apiname></xref> to retrieve the connection settings.</p><p>The system-wide connection management APIs are deprecated so avoid |
|
133 using it. Instead, use the following <xref href="GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2.dita"><apiname>RConnectionServ</apiname></xref> APIs:</p><ul> |
|
134 <li><p><xref href="GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2.dita#GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2/GUID-A2ED3E49-53F0-3BFD-8E77-DE543BAADA93"><apiname>RConnectionServ::AccessPointStatusQuery(const CConnectionServParameterBundle& |
|
135 aQuery, CConnectionServParameterBundle& aResult, TRequestStatus& |
|
136 aStatus)</apiname></xref></p></li> |
|
137 <li><p><xref href="GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2.dita#GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2/GUID-31901844-6423-3B20-86DA-58DE2443885A"><apiname>RConnectionServ::AccessPointNotification(const CConnectionServParameterBundle& |
|
138 aQuery, MAccessPointNotificationObserver& aObserver)</apiname></xref></p></li> |
|
139 <li><p><xref href="GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2.dita#GUID-55FE59B7-4FA9-3B1A-BD4C-9B7611FE75C2/GUID-96F75179-AE3E-3CC5-9C25-63E66053D99E"><apiname>RConnectionServ::CancelAccessPointNotification()</apiname></xref></p></li> |
|
140 </ul><p>For more information on how to use these APIs, refer to <xref href="GUID-AE31B2A5-40BA-5FD4-9CCA-2CDF5B00DFDC.dita">Using a Management |
|
141 Plane session to receive Access Point notifications: Tutorial</xref>.</p></entry> |
|
142 </row> |
|
143 <row> |
|
144 <entry><codeph>CFbsDevice::CancelSprite()</codeph>, <codeph>CFbsDevice::HideSprite()</codeph>,<codeph>CFbsDevice::HideSprite(const TRect&, const TRegion*)</codeph>, <codeph>CFbsDevice::ShowSprite(TSpriteBase*)</codeph>, <codeph>CFbsDevice::ShowSprite(TSpriteBase*, const TRect&,const TRegion*)</codeph>, <codeph>CFbsScreenDevice::DrawSpriteBegin()</codeph>, <codeph>CFbsScreenDevice::DrawSpriteEnd()</codeph>, <codeph>CFbsScreenDevice::CancelSprite()</codeph>, <codeph>CFbsScreenDevice::HideSprite()</codeph>, <codeph>CFbsScreenDevice::HideSprite(const TRect&,const TRegion*)</codeph>, <codeph>CFbsScreenDevice::ShowSprite(TSpriteBase*)</codeph>, and <codeph>CFbsScreenDevice::ShowSprite(TSpriteBase*, const TRect&,const |
|
145 TRegion*)</codeph>.</entry> |
|
146 <entry><filepath>bitdev.h</filepath></entry> |
|
147 <entry>These <codeph>CFbsDevice</codeph> and <codeph>CFbsScreenDevice</codeph> APIs, which were used internally by the Window Server |
|
148 for implementing sprites, are deprecated from Symbian^3 onwards. </entry> |
|
149 </row> |
|
150 <row> |
|
151 |
|
152 <entry>Flash Viewer Framework API</entry> |
|
153 <entry><filepath>flash_ui.h</filepath> and <filepath>flash2ui.dll</filepath></entry> |
|
154 <entry>This framework API is deprecated so remove all references to |
|
155 it.</entry> |
|
156 </row> |
|
157 <row> |
|
158 <entry>Browser Control API, Browser Plugin API, Download Manager Client |
|
159 API, Download Manager UI API, Favourites Engine API, and Settings |
|
160 API</entry> |
|
161 <entry><filepath>browserengine.lib</filepath>, <filepath>browserengine.lib</filepath>, <filepath>downloadmgr.lib</filepath>, <filepath>downloadmgruilib.lib</filepath>, and <filepath>favouritesengine.lib</filepath>.</entry> |
|
162 <entry>All these browser APIs are deprecated, so start using the <xref format="html" href="http://doc.qt.nokia.com/4.6/qtwebkit.html" scope="external">QTWebKit</xref> module instead. </entry> |
|
163 </row> |
|
164 </tbody> |
|
165 </tgroup> |
|
166 </table></conbody></concept> |