Collapse all Symbian^3 Product Developer Library

CXdmProtocolInfo Class Reference

class CXdmProtocolInfo : public CBase

Inherits from

CXdmProtocolInfo
- CBase

Public Member Functions
	~CXdmProtocolInfo()
IMPORT_C TInt	AccessPoint()
IMPORT_C const TXdmCredentials &	Credentials()
IMPORT_C TBool	IsCacheEnabled()
IMPORT_C TBool	IsSecure()
IMPORT_C CXdmProtocolInfo *	NewL(TInt, TInt, const TDesC &)
IMPORT_C CXdmProtocolInfo *	NewL(TInt)
IMPORT_C TUid	ProtocolUid()
IMPORT_C TPtrC	Root()
IMPORT_C void	SetCacheUsage(TBool)
IMPORT_C void	SetCredentials(const TXdmCredentials)
IMPORT_C void	SetSecurity(TBool)
IMPORT_C TInt	SettingsID()

Private Member Functions
	CXdmProtocolInfo()
	CXdmProtocolInfo(TInt)
	CXdmProtocolInfo(TInt, TInt)
void	Construct(TInt)
void	ConstructL(const TDesC &)

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()

Private Attributes
TInt	iAccessPoint
TXdmCredentials	iCredentials
TUid	iProtocolUid
HBufC *	iRootLocation
TBool	iSecure
TInt	iSettingsId
TBool	iUseCache

Constructor & Destructor Documentation

CXdmProtocolInfo()

CXdmProtocolInfo

(

)

[private]

C++ constructor is private

CXdmProtocolInfo(TInt)

CXdmProtocolInfo

(

TInt

aProtocolUid

)

[private]

C++ constructor is private

Parameters

TInt aProtocolUid

CXdmProtocolInfo(TInt, TInt)

CXdmProtocolInfo	(	TInt	aAccessPoint,
		TInt	aProtocolUid
	)	[private]

C++ constructor is private

Parameters

TInt aAccessPoint
TInt aProtocolUid

~CXdmProtocolInfo()

IMPORT_C

~CXdmProtocolInfo

(

)

[virtual]

Destructor

Member Functions Documentation

AccessPoint()

IMPORT_C TInt

AccessPoint

(

)

const

Return the access point

Construct(TInt)

void

Construct

(

TInt

aSettingsId

)

[private]

Symbian OS non-leaving constructor

Parameters

TInt aSettingsId

ConstructL(const TDesC &)

void

ConstructL

(

const TDesC &

aRootLocation

)

[private]

Symbian OS second-phase constructor

Parameters

const TDesC & aRootLocation

Credentials()

IMPORT_C const TXdmCredentials &

Credentials

(

)

const

Return the credentials

IsCacheEnabled()

IMPORT_C TBool

IsCacheEnabled

(

)

const

Check cache usage

IsSecure()

IMPORT_C TBool

IsSecure

(

)

const

Is secure transfer enabled

NewL(TInt, TInt, const TDesC &)

IMPORT_C CXdmProtocolInfo *	NewL	(	TInt	aAccessPoint,
			TInt	aProtocolUid,
			const TDesC &	aRootLocation
		)	[static]

Create a new protocol info object

Parameters

TInt aAccessPoint
TInt aProtocolUid
const TDesC & aRootLocation

NewL(TInt)

IMPORT_C CXdmProtocolInfo *

NewL

(

TInt

aSettingsId

)

[static]

Create a new protocol info object

NOTE: In order to be able to use this overload of the constructor, the client must first fetch the collection of XDM Settings through the static method XdmSettingsL() declared in CXdmEngine API. This method returns an array of strings, which denote the names of the settings collections stored for XDM.

Parameters

TInt aSettingsId

ProtocolUid()

IMPORT_C TUid

ProtocolUid

(

)

const

Return the the UID of the protocol in use

Root()

IMPORT_C TPtrC

Root

(

)

const

Return the root location of the XDM documents

SetCacheUsage(TBool)

IMPORT_C void

SetCacheUsage

(

TBool

aCacheUsage

)

Enable/disable cache

Parameters

TBool aCacheUsage

SetCredentials(const TXdmCredentials)

IMPORT_C void

SetCredentials

(

const TXdmCredentials

aCredentials

)

Set appropriate credentials in case the used resource requires authorization.

Parameters

const TXdmCredentials aCredentials

SetSecurity(TBool)

IMPORT_C void

SetSecurity

(

TBool

aSecure

)

Enable/disable secure transfer

Parameters

TBool aSecure

SettingsID()

IMPORT_C TInt

SettingsID

(

)

const

Return the ID of the settings

Member Data Documentation

TInt iAccessPoint

TInt

iAccessPoint

[private]

TXdmCredentials iCredentials

TXdmCredentials

iCredentials

[private]

TUid iProtocolUid

TUid

iProtocolUid

[private]

HBufC * iRootLocation

HBufC *

iRootLocation

[private]

TBool iSecure

TBool

iSecure

[private]

TInt iSettingsId

TInt

iSettingsId

[private]

TBool iUseCache

TBool

iUseCache

[private]