Privacy Request API

The Privacy Request API is an interface through which the LBS subsystem can receive and respond to privacy requests when it is built to include the Privacy Protocol Module.

Introduction

The Privacy Request API supports device creators who wish to use the Symbian LBS subsystem to handle only privacy requests but not to perform position fix calculations.

The API is an alternative to the Network Privacy API. The Privacy Request API is intended for processing multiple privacy requests either from local applications or from the network.

Description

The Privacy Request API is implemented on the client-side by the Privacy Request Client DLL. This DLL is an interface to the Privacy Protocol Module.

The Privacy Request API does not guarantee performance in low memory conditions for which a privacy request may fail. For this reason the Privacy Request API and the Privacy Protocol Module should not be used when there is a need to support emergency services privacy requests from the network (MT-LR or NI-LR). A Protocol Module that handles location requests must be used if emergency services requests must be supported.

Figure 1 shows the Privacy Request Client DLL in the context of the LBS subsystem. The most important points to note are:

  • The Privacy Request Client DLL exposes the Privacy Request API which is described in this document. The DLL is used to send privacy requests into the Symbian LBS subsystem from a component running in the licensee's domestic OS (outside of the Symbian platform).

  • The Privacy Request Client DLL connects to a server implementation in the Privacy Protocol Module.

  • A device creator does not create their own implementation of the Privacy Request Client DLL or the Privacy Protocol Module. A device creator chooses to build a ROM containing the Privacy Protocol Module and the Privacy Request Client DLL. See LBS Integration and Configuration Guide for more information about building and configuring the LBS subsystem.

  • To use the Privacy Request API a device creator must implement some kind of client process in their domestic operating system which uses the Privacy Request API.

    The Privacy Request API client process must implement the API observer interface to receive privacy responses. The client process, and not Symbian LBS is responsible for sending these privacy responses to the network.

Figure 1. Figure 1. The Privacy Request API in the LBS Standalone Privacy Mode configuration.

Privacy Request Client DLL responsibilities

The Privacy Request Client DLL communicates with the Privacy Protocol Module via standard Symbian client-server IPC calls. The DLL performs two distinct functions:

  1. It starts up the LBS subsystem if it is not already running.

    The privacy handling components shown in figure 1 are transient. They are started only on demand when a client process creates an instance of a Privacy Request API class.

    The LBS Integration and Configuration Guide describes how to configure the components that are started when the first privacy request is received. Privacy Request API Reference contains sequences that describe startup and shutdown behaviour.

  2. It packages the Privacy Request API, which forwards privacy requests from a licensee client process into the Symbian LBS subsystem. Privacy responses returned from a Privacy Controller or Privacy Notifiers are returned to the client.

Privacy Request API description

Figure 2 shows the classes of the Privacy Request API.

Figure 2. Figure 2. Privacy Request API classes

The following table lists the classes and types that define the Privacy Request API. Further details can be found by following the links to other sections of this document and to the Symbian Developer Library reference documentation.

The Privacy Request API has publishedPartner interface access. Licensees use the following classes to send privacy requests and receive privacy responses via the API.

Class name Description Header file

CLbsPrivacyRequest

The main interface class of the Privacy Request API. It is used to send privacy requests into the LBS subsystem.

lbsprivacyrequest.h

MLbsPrivacyRequestObserver

The observer class that must be implemented by a Privacy Request API client. Its methods are called by the LBS subsystem to send privacy responses to the client.

lbsprivacyrequest.h

TLbsPrivacyRequest

A class derived from TLbsPrivacyClassTypeBase that holds privacy request parameters.

lbsprivacyrequestcommon.h

TLbsPrivacyClassTypeBase

The base class of classes that stores privacy request parameters which are passed from the API client to the LBS subsystem. A Privacy Request API client does not use this class directly.

lbsprivacyrequestcommon.h

TLbsPrivacyRequestClassType

An enumeration that defines the type of privacy request class (derived from TLbsPrivacyRequestClassType) that is passed from the API client to the LBS subsystem. A Privacy Request API client does not use this type directly. It is used internally within the Privacy Request API.

lbsprivacyrequestclasstypes.h

Capabilities

The Privacy Request API is packaged in lbsprivacyrequest.dll. Clients link to lbsprivacyrequest.lib.

Libraries

To use the Privacy Request API to handle privacy requests from a local application requires the capabilities Location and ReadDeviceData. To handle privacy requests from the network requires the additional NetworkServices capability.