CRequestor Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

#include <lbsrequestor.h>

Inherits CRequestorBase.

Detailed Description

Each instance of a CRequestor class is used to hold the identity of one of the parties involved requesting the location.

The class contains three data fields that indicate:

If the requesting party is a "service" or an actual person ("contact").
A descriptor that contains the requestor string and
A field that identifies the format of the requestor string. For example, the requestor may be a telephone number, URL or email address.


Public Member Functions
	~CRequestor ()
	Destructor for CRequestor.
Static Public Member Functions
static IMPORT_C CRequestor *	New (TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData)
	Allocates and constructs a CRequestor object.
static IMPORT_C CRequestor *	NewL (TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData)
	Allocates and constructs a CRequestor object.
static IMPORT_C CRequestor *	NewLC (TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData)
	Allocates and constructs a CRequestor object, and leaves the object on the cleanup stack.
static IMPORT_C CRequestor *	NewL (RReadStream &aStream)
	Allocates and constructs a CRequestor object.

Constructor & Destructor Documentation

CRequestor::~CRequestor

(

)

Destructor for CRequestor.

Member Function Documentation

static IMPORT_C CRequestor* CRequestor::New	(	TRequestorType	aType,
		TRequestorFormat	aFormat,
		const TDesC &	aData
	)	`[static]`

Allocates and constructs a CRequestor object.

This construction method initializes the requestor type, format and string with the respective values in the arguments.

The function is a non-leaving variation which returns NULL if there is insufficient memory.

Parameters:

	aType	identifies the type of the requestor, a service or a contact.
	aFormat	identifies the format of the requestor string. The format field indicates whether the requestor string is a telephone number, URL or email address.
`[in]`	aData	identifies the requestor string. The requestor string can be a telephone number, a URL etc.

Returns:: a newly created CRequestor object, or NULL.

static IMPORT_C CRequestor* CRequestor::NewL ( RReadStream & aStream ) [static]

Allocates and constructs a CRequestor object.

This construction method initializes the requestor type, format and string with the respective values read from the read stream.

The function leaves if there is insufficient memory.

Parameters:

[in] aStream The stream that contains an externalized CRequestor object.

Returns:: a newly created CRequestor object.

static IMPORT_C CRequestor* CRequestor::NewL	(	TRequestorType	aType,
		TRequestorFormat	aFormat,
		const TDesC &	aData
	)	`[static]`

Allocates and constructs a CRequestor object.

This construction method initializes the requestor type, format and string with the respective values in the arguments.

The function leaves if there is insufficient memory.

Parameters:

	aType	identifies the type of requestor, a service or a contact.
	aFormat	identifies the format of the requestor string. The format field indicates whether the requestor string is a telephone number, URL or email address.
`[in]`	aData	identifies the requestor string. The requestor string can be a telephone number, a URL etc.

Returns:: a newly created CRequestor object.

static IMPORT_C CRequestor* CRequestor::NewLC	(	TRequestorType	aType,
		TRequestorFormat	aFormat,
		const TDesC &	aData
	)	`[static]`

Allocates and constructs a CRequestor object, and leaves the object on the cleanup stack.

This construction method initializes the requestor type, format and string with the respective values in the arguments.

The function leaves if there is insufficient memory.

Parameters:

	aType	identifies the type of requestor, a service or a contact.
	aFormat	identifies the format of the requestor string. The format field indicates whether the requestor string is a telephone number, URL or email address.
`[in]`	aData	identifies the requestor string. The requestor string can be a telephone number, a URL etc.

Returns:: a newly created CRequestor object.

The documentation for this class was generated from the following file:

lbsrequestor.h

CRequestor Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation