Collapse all Symbian^3 Application Developer Library

CPosRequestor Class Reference

class CPosRequestor : public CBase

The base class for a requester in the Privacy Data Types. A requester is either a contact or a service and it is identified by a string. The string may be a phone number, URL, email address, etc.

CPosContactRequestor CPosServiceRequestor None

Inherits from

CPosRequestor
- CBase

Public Member Functions
	~CPosRequestor ()
IMPORT_C TNetworkType	NetworkType ()
IMPORT_C TRequestType	RequestType ()
IMPORT_C TRequestorIdFormat	RequestorIdFormat ()
IMPORT_C TPtrC	RequestorIdString ()
IMPORT_C TRequestorType	RequestorType ()
IMPORT_C void	SetNetworkType (const TNetworkType )
IMPORT_C void	SetRequestType (const TRequestType )
IMPORT_C void	SetRequestorIdL ( TRequestorIdFormat , const TDesC &)

Protected Member Functions
	CPosRequestor ( TRequestorType , TRequestorIdFormat , HBufC *, TNetworkType , TRequestType )

Private Member Functions
	CPosRequestor (const CPosRequestor &)
CPosRequestor &	operator= (const CPosRequestor &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TRequestorIdFormat { EIdFormatUnknown , EIdFormatGenericName , EIdFormatPhoneNumber , EIdFormatUrl , EIdFormatEmail , EIdFormatSIPUrl , EIdFormatIMSPublicIdentity , EIdFormatMIN , EIdFormatMDN }
enum	TRequestorType { ERequestorService , ERequestorContact }
enum	_TNetworkType { ENetworkTypeUnknown = 0, ENetworkGSM = 1, ENetworkSUPL = 2, ENetworkWCDMA = 3 }
enum	_TRequestType { ERequestTypeUnknown = 0, ERequestSingleShot = 1, ERequestPeriodic = 2, ERequestAreaEvent = 3 }

Public Member Type Definitions
typedef	TUint32 TNetworkType
typedef	TUint32 TRequestType

Private Attributes
TRequestorIdFormat	iIdFormat
HBufC *	iIdString
TNetworkType	iNetworkType
TRequestType	iRequestType
TRequestorType	iRequestorType

Constructor & Destructor Documentation

CPosRequestor(TRequestorType, TRequestorIdFormat, HBufC *, TNetworkType, TRequestType)

CPosRequestor	(	TRequestorType	aRequestorType,
		TRequestorIdFormat	aIdFormat,
		HBufC *	aIdString,
		TNetworkType	aNetworkType,
		TRequestType	aRequestType
	)	[protected]

Default constructor

Parameters

TRequestorType aRequestorType
TRequestorIdFormat aIdFormat
HBufC * aIdString
TNetworkType aNetworkType
TRequestType aRequestType

CPosRequestor(const CPosRequestor &)

CPosRequestor

(

const CPosRequestor &

)

[private]

Parameters

const CPosRequestor &

~CPosRequestor()

IMPORT_C

~CPosRequestor

(

)

[virtual]

Default destructor

Member Functions Documentation

NetworkType()

IMPORT_C TNetworkType

NetworkType

(

)

const

Gets the network type (GSM, SUPL or WCDMA).

RequestType()

IMPORT_C TRequestType

RequestType

(

)

const

Gets the request type (single shot, periodic or area event). This value is not currently used. @ return The type of the request

RequestorIdFormat()

IMPORT_C TRequestorIdFormat

RequestorIdFormat

(

)

const

Gets the format of the requester ID string, such as a phone number, email address, URL etc.

RequestorIdString()

IMPORT_C TPtrC

RequestorIdString

(

)

const

Gets the requester ID string which identifies the contact or service making the privacy request.

RequestorType()

IMPORT_C TRequestorType

RequestorType

(

)

const

Gets the requester type: a contact or a service.

If the requester is a contact, it can be cast to CPosContactRequestor . If the requester is a service, it can be cast to CPosServiceRequestor . CPosContactRequestor CPosServiceRequestor

SetNetworkType(const TNetworkType)

IMPORT_C void

SetNetworkType

(

const TNetworkType

aNetworkType

)

Sets the network type (GSM, SUPL or WCDMA).

Parameters

const TNetworkType aNetworkType

The network type.

SetRequestType(const TRequestType)

IMPORT_C void

SetRequestType

(

const TRequestType

aRequestType

)

Sets the request type (single shot, periodic or area event). This value is not currently used.

Parameters

const TRequestType aRequestType

The type of the request

SetRequestorIdL(TRequestorIdFormat, const TDesC &)

IMPORT_C void	SetRequestorIdL	(	TRequestorIdFormat	aIdFormat,
			const TDesC &	aIdString
		)

Sets the requester id. The requester id is a string that identifies the person or service making the privacy request.

Parameters

TRequestorIdFormat aIdFormat	The format of the requester id string, such as a phone number, URL, email address, etc.
const TDesC & aIdString	A string that identifies the requester.

operator=(const CPosRequestor &)

CPosRequestor &

operator=

(

const CPosRequestor &

)

[private]

Parameters

const CPosRequestor &

Member Enumerations Documentation

Enum TRequestorIdFormat

This enum specifies how a requestor is identified.

Enumerators

EIdFormatUnknown	The requestor ID format is unknown.
EIdFormatGenericName	The requestor is identified by name.
EIdFormatPhoneNumber	The requestor is identified by phone number.
EIdFormatUrl	The requestor is identified by URL.
EIdFormatEmail	The requestor is identified by email address.
EIdFormatSIPUrl	The requestor is identified by the URL of the SIP session.
EIdFormatIMSPublicIdentity	The requestor is identified by the IMS public identity.
EIdFormatMIN	The requestor is identified by Mobile Indentification Number.
EIdFormatMDN	The requestor is identified by Mobile Directory Number.

Enum TRequestorType

This enum specifies whether the requestor is a contact or a service.

Enumerators

ERequestorService	The requestor is a service.
ERequestorContact	The requestor is a contact.

Enum _TNetworkType

Network type Note that the TNetworkType enum may be extended in the future by adding more enumerated values. To maintain compatibility any unrecognized values must be handled as ENetworkTypeUnknown.

Enumerators

ENetworkTypeUnknown = 0	Unknown network. Should be used to initialize variables
ENetworkGSM = 1	A request received over GSM
ENetworkSUPL = 2	A request received over SUPL
ENetworkWCDMA = 3	A request received over WCDMA

Enum _TRequestType

Type of request Note that the TRequestType enum may be extended in the future by adding more enumerated values. To maintain compatibility any unrecognized values must be handled as ERequestTypeUnknown.

Enumerators

ERequestTypeUnknown = 0	Unknown. Should be used to initialize variables
ERequestSingleShot = 1	The privacy request is related to a single location request
ERequestPeriodic = 2	The privacy request is related to a periodic location request
ERequestAreaEvent = 3	The privacy request is related to an area event location request

Member Type Definitions Documentation

Typedef TNetworkType

typedef TUint32

TNetworkType

Defined type for TNetworkType

Typedef TRequestType

typedef TUint32

TRequestType

Defined type for TRequestType

Member Data Documentation

TRequestorIdFormat iIdFormat

TRequestorIdFormat

iIdFormat

[private]

HBufC * iIdString

HBufC *

iIdString

[private]

TNetworkType iNetworkType

TNetworkType

iNetworkType

[private]

TRequestType iRequestType

TRequestType

iRequestType

[private]

TRequestorType iRequestorType

TRequestorType

iRequestorType

[private]