Collapse all Symbian^3 Product Developer Library

MSenPolicy Class Reference

class MSenPolicy

Example structure of Policy XML fragment:

<Policy> <Transport> <IapId> 1234567890 </IapId> </Transport> <IdentityProviderIDs strict="true"> <IdentityProviderID> urn:first.id.example.com </IdentityProviderID> <IdentityProviderID> urn:second.id.example.com </IdentityProviderID> </IdentityProviderIDs> </Policy>

Public Member Functions
TBool	Accepts(MSenPolicy &)
TInt	AddIdentityProviderIdL(const TDesC8 &)
TInt	IapId(TUint32 &)
const CSenIdentityProviderIdArray8 &	IdentityProviderIds8L()
TInt	RebuildFrom(MSenPolicy &)
void	SetIapIdL(TUint32)
void	SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)
void	SetSnapIdL(TUint32)
TInt	SnapId(TUint32 &)

Member Functions Documentation

Accepts(MSenPolicy &)

TBool

Accepts

(

MSenPolicy &

aPolicyPattern

)

[pure virtual]

Checks if policies match.

Parameters

MSenPolicy & aPolicyPattern

AddIdentityProviderIdL(const TDesC8 &)

TInt

AddIdentityProviderIdL

(

const TDesC8 &

aProviderId

)

[pure virtual]

Adds a new Identity provider ID value at the end of the current list values Checks for duplicate (does not insert new ID elements with equal content)

Parameters

const TDesC8 & aProviderId

IapId(TUint32 &)

TInt

IapId

(

TUint32 &

aCurrentIapId

)

[pure virtual]

Getter for IAP ID.

Parameters

TUint32 & aCurrentIapId

will contain the current Internet Access Point ID Max value for IAP ID is 2147483647

IdentityProviderIds8L()

const CSenIdentityProviderIdArray8 &

IdentityProviderIds8L

(

)

[pure virtual]

Getter for IdentityProvider IDs.

Since: Series60 3.0

RebuildFrom(MSenPolicy &)

TInt

RebuildFrom

(

MSenPolicy &

aTemplate

)

[pure virtual]

Method reads provider policy class instance values from given template. Values may include an IAP ID, preferred IdentityProvider IDs etc.

Since: Series60 3.0

Parameters

MSenPolicy & aTemplate

from which the values are read.

SetIapIdL(TUint32)

void

SetIapIdL

(

TUint32

aIapId

)

[pure virtual]

Setter for Internet Access Point (IAP) ID. Method is used to define default access point to avoid IAP selection dialog prompt.

Since: Series60 3.0

Parameters

TUint32 aIapId

is the ID found from CommDB.

SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)

void

SetIdentityProviderIdsL

(

CSenIdentityProviderIdArray8 &

aList

)

[pure virtual]

Setter for IdentityProvider IDs. Overrides current values with the given values from the array. When initiating a new service connection, this list of ProviderIDs define, which IdentityProviders are preferred OR which are strictly acceptable ones.

Since: Series60 3.0

Parameters

CSenIdentityProviderIdArray8 & aList

list of IdentityProvider IDs.

SetSnapIdL(TUint32)

void

SetSnapIdL

(

TUint32

aSnapId

)

[pure virtual]

Parameters

TUint32 aSnapId

SnapId(TUint32 &)

TInt

SnapId

(

TUint32 &

aCurrentSnapId

)

[pure virtual]

Parameters

TUint32 & aCurrentSnapId