CXdmProtocolInfo Class Reference

class CXdmProtocolInfo : public CBase

Inherits from

Constructor & Destructor Documentation

CXdmProtocolInfo()

CXdmProtocolInfo()[private]

C++ constructor is private

CXdmProtocolInfo(TInt)

CXdmProtocolInfo(TIntaProtocolUid)[private]

C++ constructor is private

Parameters

TInt aProtocolUid

CXdmProtocolInfo(TInt, TInt)

CXdmProtocolInfo(TIntaAccessPoint,
TIntaProtocolUid
)[private]

C++ constructor is private

Parameters

TInt aAccessPoint
TInt aProtocolUid

~CXdmProtocolInfo()

IMPORT_C~CXdmProtocolInfo()[virtual]

Destructor

Member Functions Documentation

AccessPoint()

IMPORT_C TIntAccessPoint()const

Return the access point

Construct(TInt)

voidConstruct(TIntaSettingsId)[private]

Symbian OS non-leaving constructor

Parameters

TInt aSettingsId

ConstructL(const TDesC &)

voidConstructL(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 TBoolIsCacheEnabled()const

Check cache usage

IsSecure()

IMPORT_C TBoolIsSecure()const

Is secure transfer enabled

NewL(TInt, TInt, const TDesC &)

IMPORT_C CXdmProtocolInfo *NewL(TIntaAccessPoint,
TIntaProtocolUid,
const TDesC &aRootLocation
)[static]

Create a new protocol info object

Parameters

TInt aAccessPoint
TInt aProtocolUid
const TDesC & aRootLocation

NewL(TInt)

IMPORT_C CXdmProtocolInfo *NewL(TIntaSettingsId)[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 TUidProtocolUid()const

Return the the UID of the protocol in use

Root()

IMPORT_C TPtrCRoot()const

Return the root location of the XDM documents

SetCacheUsage(TBool)

IMPORT_C voidSetCacheUsage(TBoolaCacheUsage)

Enable/disable cache

Parameters

TBool aCacheUsage

SetCredentials(const TXdmCredentials)

IMPORT_C voidSetCredentials(const TXdmCredentialsaCredentials)

Set appropriate credentials in case the used resource requires authorization.

Parameters

const TXdmCredentials aCredentials

SetSecurity(TBool)

IMPORT_C voidSetSecurity(TBoolaSecure)

Enable/disable secure transfer

Parameters

TBool aSecure

SettingsID()

IMPORT_C TIntSettingsID()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]