#include <mw/ineturilist.h>
Link against: ineturilist.lib
| class RInetUriList |
| Public Member Functions | |
|---|---|
| RInetUriList() | |
| IMPORT_C void | AddL(const RInetUri &) |
| IMPORT_C void | Close() |
| IMPORT_C TInt | Count(InetUriList::TServiceType, InetUriList::TListType) |
| IMPORT_C TInt | GetListType(const TDesC8 &, InetUriList::TServiceType, InetUriList::TListType &) |
| IMPORT_C RInetUri | OpenInetUriL(const TDesC8 &, InetUriList::TServiceType) |
| IMPORT_C void | OpenL() |
| IMPORT_C void | QueryTldInfoL(const TPolicyQueryArgs &, TQueryResults &) |
| IMPORT_C void | QueryUriL(const TQueryArgs &, MQueryResultsCallback *, MUriCustomiser *) |
| IMPORT_C void | RemoveL(const RInetUri &) |
| IMPORT_C void | UpdateL(const RInetUri &) |
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.
| IMPORT_C void | AddL | ( | const RInetUri & | aInetUri | ) |
Add a new URI object to the list and its associated storage. Requires WriteDeviceData capability.
| Parameters | |
|---|---|
| aInetUri | URI object that needs to be added. |
| Leave Codes | |
|---|---|
| KErrPermissionDenied | If the application is not having WriteDeviceData capabilities. |
| IMPORT_C TInt | Count | ( | InetUriList::TServiceType | aServiceType, |
| InetUriList::TListType | aListType | |||
| ) | ||||
Returns the number of URIs present in the list based on the given service type and list type. Requires ReadDeviceData capabilities.
| Parameters | |
|---|---|
| aServiceType | Service type (EBrowser, EWapPush, EPushEMail, EVoip and so on.) |
| aListType | List type (EWhiteList and EBlackList) |
| IMPORT_C TInt | GetListType | ( | const TDesC8 & | aUri, |
| InetUriList::TServiceType | aServiceType, | |||
| InetUriList::TListType & | aListType | |||
| ) | ||||
Retrieves the type associated with the URI by a given service type. Requires no capabilities.
| Parameters | |
|---|---|
| aUri | URI descriptor for which list type need to be retrieved |
| aServiceType | The servicetype associated with the URI |
| aListType | Returns the list type of URI( EWhiteList or EBlackList ) |
| IMPORT_C RInetUri | OpenInetUriL | ( | const TDesC8 & | aUri, |
| InetUriList::TServiceType | aServiceType | |||
| ) | ||||
Opens a URI object, which can be used to idenitfy the properties associated with the URI. Removing or updating the URI from the list can be done with this object. Requires ReadDeviceData capabilities.
| Parameters | |
|---|---|
| aUri | URI input descriptor for which the information need to be retrieved |
| aServiceType | Service type of the URI |
| Leave Codes | |
|---|---|
| KErrPermissionDenied | The application is not having ReadDeviceData capabilities. |
| KErrUriNotFound | The URI is not present in the list for the specified service type. |
| IMPORT_C void | OpenL | ( | ) |
Opens a URI list object. The function connects to the URI list server.
| IMPORT_C void | QueryTldInfoL | ( | const TPolicyQueryArgs & | aQueryArgs, |
| TQueryResults & | aResultArgs | |||
| ) | ||||
Queries on Uri either to fetch the TLD Policy data or get the List type of the given Uri.
| Parameters | |
|---|---|
| aResultArgs | is out parmeter contains either List type info or Charset info. Based on the QueryType. |
| Leave Codes | |
|---|---|
| KErrInvalidTLD | The TLD type if No policy data is available for the given TLD. |
| IMPORT_C void | QueryUriL | ( | const TQueryArgs & | aArgs, |
| MQueryResultsCallback * | aQueryCallback, | |||
| MUriCustomiser * | aUriOptimiser = NULL | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| 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. |
| Leave Codes | |
|---|---|
| KErrServiceTypeNotPresent | The service type is not specified in the query argument. |
| IMPORT_C void | RemoveL | ( | const RInetUri & | aInetUri | ) |
Removes a URI object from the list and its associated storage. Requires WriteDeviceData capabilities.
| Parameters | |
|---|---|
| aInetUri | URI object that needs to be removed. |
| Leave Codes | |
|---|---|
| KErrPermissionDenied | If the application is not having WriteDeviceData capabilities. |
| KErrUriReadOnly | URI object is read-only and cannot be removed. |
| IMPORT_C void | UpdateL | ( | const RInetUri & | aInetUri | ) |
Updates the URI object properties. Only favourite name and list type can be modified. Requires WriteDeviceData capabilities.
| Parameters | |
|---|---|
| aInetUri | URI object that needs to be updated |
| Leave Codes | |
|---|---|
| KErrPermissionDenied | If the application is not having WriteDeviceData capabilities. |
| KErrUriReadOnly | URI object is read-only and cannot be modified. |