Collapse all Symbian^3 Product Developer Library

TLbsExternalRequestInfo Class Reference

class TLbsExternalRequestInfo : public TLbsLocClassTypeBase

Contains information about the external location requester when a location request is received from the network (MT-LR).

Inherits from

TLbsExternalRequestInfo
- TLbsLocClassTypeBase

Public Member Functions
	TLbsExternalRequestInfo()
IMPORT_C TCodingScheme	ClientNameCodingScheme()
IMPORT_C TFormatIndicator	ClientNameFormat()
IMPORT_C void	GetClientExternalId(TDes8 &)
IMPORT_C void	GetClientName(TDes8 &)
IMPORT_C void	GetClientName(TDes16 &)
IMPORT_C void	GetRequesterId(TDes8 &)
IMPORT_C void	GetRequesterId(TDes16 &)
IMPORT_C TNetworkType	NetworkType()
IMPORT_C TRequestSource	RequestSource()
IMPORT_C TRequestType	RequestType()
IMPORT_C TCodingScheme	RequesterIdCodingScheme()
IMPORT_C TFormatIndicator	RequesterIdFormat()
IMPORT_C void	SetClientExternalId(const TDesC8 &)
IMPORT_C void	SetClientName(const TDesC8 &)
IMPORT_C void	SetClientName(const TDesC16 &)
IMPORT_C void	SetClientNameCodingScheme(const TCodingScheme)
IMPORT_C void	SetClientNameFormat(const TFormatIndicator)
IMPORT_C void	SetNetworkType(const TNetworkType)
IMPORT_C void	SetRequestSource(const TRequestSource)
IMPORT_C void	SetRequestType(const TRequestType)
IMPORT_C void	SetRequesterId(const TDesC8 &)
IMPORT_C void	SetRequesterId(const TDesC16 &)
IMPORT_C void	SetRequesterIdCodingScheme(const TCodingScheme)
IMPORT_C void	SetRequesterIdFormat(const TFormatIndicator)

Inherited Functions
	TLbsLocClassTypeBase::ClassSize()const
	TLbsLocClassTypeBase::ClassType()const
	TLbsLocClassTypeBase::TLbsLocClassTypeBase()

Public Member Enumerations
enum	_TCodingScheme { ECodingSchemeUnknown = 0, ECodingSchemeUCS2 = 1, ECodingSchemeGSMDefault = 2, ECodingSchemeUTF8 = 3 }
enum	_TFormatIndicator { EFormatUnknown = 0, EFormatLogicalName = 1, EFormatEmailAddress = 2, EFormatMSISDN = 3, EFormatURL = 4, EFormatSIPURL = 5, EFormatIMSPublicIdentity = 6, EFormatMIN = 7, EFormatMDN = 8, EFormatAppUID = 9 }
enum	_TNetworkType { ENetworkTypeUnknown = 0, ENetworkGSM = 1, ENetworkSUPL = 2, ENetworkWCDMA = 3 }
enum	_TRequestSource { ERequestSourceUnknown = 0, ERequestSourceLocal = 1, ERequestSourceNetwork = 2 }
enum	_TRequestType { ERequestTypeUnknown = 0, ERequestSingleShot = 1, ERequestPeriodic = 2, ERequestAreaEvent = 3, ERequestSingleShotSilent = 4, ERequestPeriodicSilent = 5, ERequestAreaEventSilent = 6, ERequestTypeMaxEnum = 7 }

Public Member Type Definitions
typedef	TUint32 TCodingScheme
typedef	TUint32 TFormatIndicator
typedef	TUint32 TNetworkType
typedef	TUint32 TRequestSource
typedef	TUint32 TRequestType

Private Attributes
TUint8	iClientCoding
TLbsClientExternalId	iClientExternalId
TInt8	iClientFormat
TLbsClientName	iClientName
TInt8	iNetworkType
TInt8	iRequestSource
TInt8	iRequestType
TUint8	iRequesterCoding
TInt8	iRequesterFormat
TLbsRequesterId	iRequesterId
TUint8	iReserved

Inherited Attributes
	TLbsLocClassTypeBase::iClassSize
	TLbsLocClassTypeBase::iClassType

Constructor & Destructor Documentation

TLbsExternalRequestInfo()

IMPORT_C

TLbsExternalRequestInfo

(

)

Constructor for TLbsExternalRequestInfo

Member Functions Documentation

ClientNameCodingScheme()

IMPORT_C TCodingScheme

ClientNameCodingScheme

(

)

const

Get the client name coding scheme.

ClientNameFormat()

IMPORT_C TFormatIndicator

ClientNameFormat

(

)

const

Get the client name format indicator.

GetClientExternalId(TDes8 &)

IMPORT_C void

GetClientExternalId

(

TDes8 &

aClientExternalId

)

const

Get the client external Id as a raw 8-bit buffer.

Parameters

TDes8 & aClientExternalId

Reference to a descriptor which Client External Id is copied into.

GetClientName(TDes8 &)

IMPORT_C void

GetClientName

(

TDes8 &

aClientName

)

const

Get the client name as a raw 8-bit buffer.

Parameters

TDes8 & aClientName

Reference to a descriptor which Client Name is copied into.

GetClientName(TDes16 &)

IMPORT_C void

GetClientName

(

TDes16 &

aClientName

)

const

Get the client name as a unicode string. Should be used only if the coding scheme is unicode.

ClientNameCodingScheme

Parameters

TDes16 & aClientName

Reference to a descriptor which Client Name is copied into.

GetRequesterId(TDes8 &)

IMPORT_C void

GetRequesterId

(

TDes8 &

aRequesterId

)

const

Get the requester Id as a raw 8-bit buffer.

Parameters

TDes8 & aRequesterId

Reference to a descriptor which Requester Id is copied into.

GetRequesterId(TDes16 &)

IMPORT_C void

GetRequesterId

(

TDes16 &

aRequesterId

)

const

Get the requester Id as a unicode string. Should be used only if the coding scheme is unicode.

RequesterIdCodingScheme

Parameters

TDes16 & aRequesterId

Reference to a descriptor which Requester Id is copied into.

NetworkType()

IMPORT_C TNetworkType

NetworkType

(

)

const

Get the network type.

RequestSource()

IMPORT_C TRequestSource

RequestSource

(

)

const

Get the request source. (e.g. local or network)

RequestType()

IMPORT_C TRequestType

RequestType

(

)

const

Get the request type.

RequesterIdCodingScheme()

IMPORT_C TCodingScheme

RequesterIdCodingScheme

(

)

const

Get the requester id coding scheme.

RequesterIdFormat()

IMPORT_C TFormatIndicator

RequesterIdFormat

(

)

const

Get the requester id format indicator.

SetClientExternalId(const TDesC8 &)

IMPORT_C void

SetClientExternalId

(

const TDesC8 &

aClientExternalId

)

Set the client external Id as a raw 8-bit buffer.

Parameters

const TDesC8 & aClientExternalId

Reference to a descriptor that contains the client external Id.

SetClientName(const TDesC8 &)

IMPORT_C void

SetClientName

(

const TDesC8 &

aClientName

)

Set the client name as a raw 8-bit buffer. Note that it does not automatically change the coding scheme that must be set separately.

SetClientNameCodingScheme ClientNameCodingScheme

Parameters

const TDesC8 & aClientName

Reference to a descriptor that contains the client name.

SetClientName(const TDesC16 &)

IMPORT_C void

SetClientName

(

const TDesC16 &

aClientName

)

Set the client name as a unicode string. Note that it does not automatically change the coding scheme that must be set separately.

SetClientNameCodingScheme ClientNameCodingScheme

Parameters

const TDesC16 & aClientName

Reference to a descriptor that contains the client name.

SetClientNameCodingScheme(const TCodingScheme)

IMPORT_C void

SetClientNameCodingScheme

(

const TCodingScheme

aCoding

)

Set the client name coding scheme.

Parameters

const TCodingScheme aCoding

The client name coding scheme.

SetClientNameFormat(const TFormatIndicator)

IMPORT_C void

SetClientNameFormat

(

const TFormatIndicator

aFormat

)

Set the client name format indicator.

Parameters

const TFormatIndicator aFormat

The client name format indicator.

SetNetworkType(const TNetworkType)

IMPORT_C void

SetNetworkType

(

const TNetworkType

aNetworkType

)

Set the network type.

Parameters

const TNetworkType aNetworkType

The network type.

SetRequestSource(const TRequestSource)

IMPORT_C void

SetRequestSource

(

const TRequestSource

aRequestSource

)

Set the request source. (e.g. local or network)

Parameters

const TRequestSource aRequestSource

The request source.

SetRequestType(const TRequestType)

IMPORT_C void

SetRequestType

(

const TRequestType

aRequestType

)

Set the request type.

Parameters

const TRequestType aRequestType

The request type.

SetRequesterId(const TDesC8 &)

IMPORT_C void

SetRequesterId

(

const TDesC8 &

aRequesterId

)

Set the requester Id as a raw 8-bit buffer. Note that it does not automatically change the coding scheme that must be set separately.

SetRequesterIdCodingScheme RequesterIdCodingScheme

Parameters

const TDesC8 & aRequesterId

Reference to a descriptor that contains the requester Id.

SetRequesterId(const TDesC16 &)

IMPORT_C void

SetRequesterId

(

const TDesC16 &

aRequesterId

)

Set the requester Id as a unicode string. Note that it does not automatically change the coding scheme that must be set separately.

SetRequesterIdCodingScheme RequesterIdCodingScheme

Parameters

const TDesC16 & aRequesterId

Reference to a descriptor that contains the requester Id.

SetRequesterIdCodingScheme(const TCodingScheme)

IMPORT_C void

SetRequesterIdCodingScheme

(

const TCodingScheme

aCoding

)

Set the requester id coding scheme.

Parameters

const TCodingScheme aCoding

The requester id coding scheme.

SetRequesterIdFormat(const TFormatIndicator)

IMPORT_C void

SetRequesterIdFormat

(

const TFormatIndicator

aFormat

)

Set the requester id format indicator.

Parameters

const TFormatIndicator aFormat

The requester id format indicator.

Member Enumerations Documentation

Enum _TCodingScheme

This enum specifies string encoding type. Note that the TCodingScheme enum may be extended in the future by adding more enumerated values. To maintain compatibility any unrecognized values must be handled as ECodingSchemeUnknown.

Enumerators

ECodingSchemeUnknown = 0	Unknown. Should be used to initialize variables
ECodingSchemeUCS2 = 1	2-byte Universal Character Set
ECodingSchemeGSMDefault = 2	7-bit default alphabet and the SMS packaging specified in [3GPP 23.038]
ECodingSchemeUTF8 = 3	8-bit UCS/Unicode Transformation Format

Enum _TFormatIndicator

This enum specifies how a requestor or an LCS client or requestor can be identified. Note that the TFormatIndicator enum may be extended in the future by adding more enumerated values. To maintain compatibility any unrecognized values must be handled as EFormatUnknown.

Enumerators

EFormatUnknown = 0	Unknown. Should be used to initialize variables
EFormatLogicalName = 1	Logical name.
EFormatEmailAddress = 2	Email address.
EFormatMSISDN = 3	Mobile subscriber phone number.
EFormatURL = 4	URL.
EFormatSIPURL = 5	URL of user in a SIP session.
EFormatIMSPublicIdentity = 6	User Identifier in an IP Multimedia Service session.
EFormatMIN = 7	Mobile Identification Number.
EFormatMDN = 8	Mobile Directory Number.
EFormatAppUID = 9	Application UID. The identifier represents a 32-bit value (TUid) and is stored as a hexadecimal string. e.g."0x12345678"

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 _TRequestSource

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

Enumerators

ERequestSourceUnknown = 0	Unknown. Should be used to initialize variables
ERequestSourceLocal = 1	The privacy request originates from a local application. capability Location The capability is checked when CLbsPrivacyRequest::NewPrivacyRequest() or CLbsPrivacyRequest::RepeatPrivacyRequest() is called. CLbsPrivacyRequest::NewPrivacyRequest() CLbsPrivacyRequest::RepeatPrivacyRequest() capability ReadDeviceData The capability is checked when CLbsPrivacyRequest::NewPrivacyRequest() or CLbsPrivacyRequest::RepeatPrivacyRequest() is called. CLbsPrivacyRequest::NewPrivacyRequest() CLbsPrivacyRequest::RepeatPrivacyRequest()
ERequestSourceNetwork = 2	The privacy request originates from a network. To get more information about a network TNetworkType capability NetworkServices The capability is checked when CLbsPrivacyRequest::NewPrivacyRequest() or CLbsPrivacyRequest::RepeatPrivacyRequest() is called. CLbsPrivacyRequest::NewPrivacyRequest() CLbsPrivacyRequest::RepeatPrivacyRequest()

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
ERequestSingleShotSilent = 4	The privacy request is related to a single location request and is advised to be handled silently (no notification or verification)
ERequestPeriodicSilent = 5	The privacy request is related to a periodic location request and is advised to be handled silently (no notification or verification)
ERequestAreaEventSilent = 6	The privacy request is related to an area event location request and it is advised to be handled silently (no notification or verification)
ERequestTypeMaxEnum = 7

Member Type Definitions Documentation

Typedef TCodingScheme

typedef TUint32

TCodingScheme

Defined type for TCodingScheme

Typedef TFormatIndicator

typedef TUint32

TFormatIndicator

Defined type for TFormatIndicator

Typedef TNetworkType

typedef TUint32

TNetworkType

Defined type for TNetworkType

Typedef TRequestSource

typedef TUint32

TRequestSource

Defined type for TRequestSource

Typedef TRequestType

typedef TUint32

TRequestType

Defined type for TRequestType

Member Data Documentation

TUint8 iClientCoding

TUint8

iClientCoding

[private]

Client coding

TLbsClientExternalId iClientExternalId

TLbsClientExternalId

iClientExternalId

[private]

Client external Id.

TInt8 iClientFormat

TInt8

iClientFormat

[private]

Client format

TLbsClientName iClientName

TLbsClientName

iClientName

[private]

Client name.

TInt8 iNetworkType

TInt8

iNetworkType

[private]

Network type

TInt8 iRequestSource

TInt8

iRequestSource

[private]

Request source

TInt8 iRequestType

TInt8

iRequestType

[private]

Request type

TUint8 iRequesterCoding

TUint8

iRequesterCoding

[private]

Requester coding

TInt8 iRequesterFormat

TInt8

iRequesterFormat

[private]

Requester format

TLbsRequesterId iRequesterId

TLbsRequesterId

iRequesterId

[private]

Requestor Id.

TUint8 iReserved

TUint8

iReserved

[private]

Reserved for future use to help maintain BC.