Collapse all Symbian^3 Product Developer Library

TPresCondIdentityMany Class Reference

class TPresCondIdentityMany

This class should be used in conjunction with an already created CPresenceXDM. The CPresenceXDM deals with the Presence rules as a whole and has communication with the server. TPresCondIdentityMany is used to manipulate the 'many' element part of a Condition in a rule. Remember to call Init function after constructing this object.

rlspresxdm.lib

Since: S60 3.2

Public Member Functions
	TPresCondIdentityMany()
IMPORT_C TInt	AddIdentitiesInManyExceptL(const TDesC &, const CDesCArray &, const TDesC &)
IMPORT_C TInt	AddIdentityInManyExceptL(const TDesC &, const TDesC &, const TDesC &)
IMPORT_C TInt	AddManyIdentityL(const TDesC &, const TDesC &)
IMPORT_C TInt	DeleteAllIdentitiesFromManyExceptL(const TDesC &, const TDesC &)
IMPORT_C TInt	GetIdentitiesFromManyExceptL(const TDesC &, CDesCArray &, const TDesC &)
IMPORT_C TInt	GetManyIdentityElementsL(const TDesC &, CDesCArray &)
IMPORT_C void	Init(CPresenceXDM *const )
IMPORT_C TBool	IsIdentityExistsInManyExceptL(const TDesC &, const TDesC &, const TDesC &)
IMPORT_C TBool	IsManyExistsL(const TDesC &, const TDesC &)
IMPORT_C TInt	RemoveIdentityFromManyExceptL(const TDesC &, const TDesC &, const TDesC &)
IMPORT_C TInt	RemoveManyIdentityL(const TDesC &, const TDesC &)

Private Member Functions
CXdmDocumentNode *	GetManyNodeL(const TDesC &, TBool, const TDesC &)
TBool	IsEntityExistInNodeArray(const RPointerArray< CXdmDocumentNode > &, const TDesC &)

Private Attributes
CPresenceXDM *	iPresXDM

Constructor & Destructor Documentation

TPresCondIdentityMany()

IMPORT_C

TPresCondIdentityMany

(

)

C++ Constructor, After contructing Init must be called before using this object.

Member Functions Documentation

AddIdentitiesInManyExceptL(const TDesC &, const CDesCArray &, const TDesC &)

IMPORT_C TInt	AddIdentitiesInManyExceptL	(	const TDesC &	aRuleID,
			const CDesCArray &	aEntities,
			const TDesC &	aDomain
		)

Add identities to 'except' child of many element

Parameters

const TDesC & aRuleID
const CDesCArray & aEntities
const TDesC & aDomain

AddIdentityInManyExceptL(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C TInt	AddIdentityInManyExceptL	(	const TDesC &	aRuleID,
			const TDesC &	aEntity,
			const TDesC &	aDomain
		)

Add identity to 'except' child of many element

Parameters

const TDesC & aRuleID
const TDesC & aEntity
const TDesC & aDomain

AddManyIdentityL(const TDesC &, const TDesC &)

IMPORT_C TInt	AddManyIdentityL	(	const TDesC &	aRuleID,
			const TDesC &	aDomain
		)

Puts the 'many' element in identity, with domain name

Parameters

const TDesC & aRuleID
const TDesC & aDomain

DeleteAllIdentitiesFromManyExceptL(const TDesC &, const TDesC &)

IMPORT_C TInt	DeleteAllIdentitiesFromManyExceptL	(	const TDesC &	aRuleID,
			const TDesC &	aDomain
		)

Deletes all identities in the 'except' child of 'many'

Parameters

const TDesC & aRuleID
const TDesC & aDomain

GetIdentitiesFromManyExceptL(const TDesC &, CDesCArray &, const TDesC &)

IMPORT_C TInt	GetIdentitiesFromManyExceptL	(	const TDesC &	aRuleID,
			CDesCArray &	aEntities,
			const TDesC &	aDomain
		)

Get identities from 'except' child of many element

Parameters

const TDesC & aRuleID
CDesCArray & aEntities
const TDesC & aDomain

GetManyIdentityElementsL(const TDesC &, CDesCArray &)

IMPORT_C TInt	GetManyIdentityElementsL	(	const TDesC &	aRuleID,
			CDesCArray &	aDomains
		)

Get the number of 'many' elements in identity node, those elements which has domain name are returned in aDomains array

Parameters

const TDesC & aRuleID
CDesCArray & aDomains

GetManyNodeL(const TDesC &, TBool, const TDesC &)

CXdmDocumentNode *	GetManyNodeL	(	const TDesC &	aRuleID,
			TBool	aCreate,
			const TDesC &	aDomain
		)	[private]

Gets the 'many' node pointer in a rule

Parameters

const TDesC & aRuleID
TBool aCreate
const TDesC & aDomain

Init(CPresenceXDM *const)

IMPORT_C void

Init

(

CPresenceXDM *const

aPresXDM

)

Initializes the object with the given pointer to CPresenceXDM. This function must be called before using other functions.

Parameters

CPresenceXDM *const aPresXDM

IsEntityExistInNodeArray(const RPointerArray< CXdmDocumentNode > &, const TDesC &)

TBool	IsEntityExistInNodeArray	(	const RPointerArray< CXdmDocumentNode > &	nodes,
			const TDesC &	aEntity
		)	[private]

Finds whether the given entity exists in the node array

Parameters

const RPointerArray< CXdmDocumentNode > & nodes
const TDesC & aEntity

IsIdentityExistsInManyExceptL(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C TBool	IsIdentityExistsInManyExceptL	(	const TDesC &	aRuleID,
			const TDesC &	aEntity,
			const TDesC &	aDomain
		)

Is identity exists in the 'except' child of many element

Parameters

const TDesC & aRuleID
const TDesC & aEntity
const TDesC & aDomain

IsManyExistsL(const TDesC &, const TDesC &)

IMPORT_C TBool	IsManyExistsL	(	const TDesC &	aRuleID,
			const TDesC &	aDomain
		)

Finds whether 'many' element exists in identities or not, with optional domain name

Parameters

const TDesC & aRuleID
const TDesC & aDomain

RemoveIdentityFromManyExceptL(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C TInt	RemoveIdentityFromManyExceptL	(	const TDesC &	aRuleID,
			const TDesC &	aEntity,
			const TDesC &	aDomain
		)

Removes an identity from 'except' child of many element

Parameters

const TDesC & aRuleID
const TDesC & aEntity
const TDesC & aDomain

RemoveManyIdentityL(const TDesC &, const TDesC &)

IMPORT_C TInt	RemoveManyIdentityL	(	const TDesC &	aRuleID,
			const TDesC &	aDomain
		)

Removes the 'many' element from identity, optional domain name

Parameters

const TDesC & aRuleID
const TDesC & aDomain

Member Data Documentation

CPresenceXDM * iPresXDM

CPresenceXDM *

iPresXDM

[private]