RInetUriList Class Reference
#include
<mw/ineturilist.h>
Link against: ineturilist.lib
Detailed Description
RInetUriList represents a handle to the list as a whole. Opening the handle will initiate a connection the URI List server. This class is responsible for adding, removing, updating, or retrieving the URI and its associated properties.
Constructor & Destructor Documentation
Member Function Documentation
AddL ( const RInetUri & )
| IMPORT_C void | AddL | ( | const RInetUri & | aInetUri | ) | |
Add a new URI object to the list and its associated storage. Requires WriteDeviceData capability.
-
leave
- KErrPermissionDenied If the application is not having WriteDeviceData capabilities.
| Parameter | Description | | aInetUri | URI object that needs to be added. |
Close ( )
Closes the URI list object.
Count ( InetUriList::TServiceType, InetUriList::TListType )
GetListType ( const TDesC8 &, InetUriList::TServiceType, InetUriList::TListType & )
OpenInetUriL ( const TDesC8 &, InetUriList::TServiceType )
OpenL ( )
Opens a URI list object. The function connects to the URI list server.
QueryTldInfoL ( const TPolicyQueryArgs &, TQueryResults & )
Queries on Uri either to fetch the TLD Policy data or get the List type of the given Uri.
-
leave
- KErrInvalidTLD The TLD type if No policy data is available for the given TLD.
| Parameter | Description | | aResultArgs | is out parmeter contains either List type info or Charset info. Based on the QueryType. |
QueryUriL ( const TQueryArgs &, MQueryResultsCallback *, MUriCustomiser * )
Queries the URI on the list. Different options are available for query operation. See TQueryArgs. The service type needs to be set in the query arguments for all queries. If a URI is set and no match criteria is specified, function will take EExact match as the matching criteria. The application must implement the result's callback function to receive the query results. The results can be controlled in the callback function, that is, the application can stop receiving the query results by returning EFalse from the query callback. Application can also implement URI customisation callback if it wishes to do protocol/ scheme-based normalisation before query.
-
leave
- KErrServiceTypeNotPresent The service type is not specified in the query argument.
| Parameter | Description | | aArgs | Query arguments. |
| aQueryCallback | Callback function that will be called on each query result. |
| aUriOptimiser | URI customiser callback function to do protocol/scheme-based normalisation before query. |
RemoveL ( const RInetUri & )
| IMPORT_C void | RemoveL | ( | const RInetUri & | aInetUri | ) | |
Removes a URI object from the list and its associated storage. Requires WriteDeviceData capabilities.
-
leave
- KErrPermissionDenied If the application is not having WriteDeviceData capabilities.
-
leave
- KErrUriReadOnly URI object is read-only and cannot be removed.
| Parameter | Description | | aInetUri | URI object that needs to be removed. |
UpdateL ( const RInetUri & )
| IMPORT_C void | UpdateL | ( | const RInetUri & | aInetUri | ) | |
Updates the URI object properties. Only favourite name and list type can be modified. Requires WriteDeviceData capabilities.
-
leave
- KErrPermissionDenied If the application is not having WriteDeviceData capabilities.
-
leave
- KErrUriReadOnly URI object is read-only and cannot be modified.
| Parameter | Description | | aInetUri | URI object that needs to be updated |