Collapse all Symbian^3 Application Developer Library

MPresenceInfoFieldCollection Class Reference

class MPresenceInfoFieldCollection : public MXIMPBase

Interface for presence field collection object.

TodoInterface might be extended with new methods.

Since: S60 v3.2

Inherits from

MPresenceInfoFieldCollection
- MXIMPBase

Public Member Functions
	~MPresenceInfoFieldCollection ()
void	AddOrReplaceFieldL ( MPresenceInfoField *)
TInt	DeleteFieldByFieldType (const TDesC8 &)
const MPresenceInfoField &	FieldAt ( TInt )
TInt	FieldCount ()
void	LookupFieldByFieldType ( MPresenceInfoField *&, const TDesC8 &)

Inherited Functions
	MXIMPBase::GetInterface(TInt32,TIfGetOps)
	MXIMPBase::GetInterface(TInt32,TIfGetOps)const
	MXIMPBase::GetInterfaceId()const
	MXIMPBase::~MXIMPBase()

Inherited Enumerations
	MXIMPBase:@26
	MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MPresenceInfoFieldCollection()

~MPresenceInfoFieldCollection

(

)

[inline, virtual]

Public destructor. MPresenceInfoFieldCollection object can be deleted through this interface.

Member Functions Documentation

AddOrReplaceFieldL(MPresenceInfoField *)

void

AddOrReplaceFieldL

(

MPresenceInfoField *

aPresenceInfoField

)

[pure virtual]

Adds new presence information field to the set. If there exists already a presence information field object in the set with equal field type, existing object is deleted and replaced with given one.

leave: KErrNoMemory if failed to allocate memory.

leave: KErrArgument if NULL argument were provided.

Parameters

MPresenceInfoField * aPresenceInfoField

New new presence information field object to add to set. Takes object ownership in success.

DeleteFieldByFieldType(const TDesC8 &)

TInt

DeleteFieldByFieldType

(

const TDesC8 &

aMatch

)

[pure virtual]

Looks up and delete the field having given name.

Parameters

const TDesC8 & aMatch

Presence information field type match pattern. Match pattern may contain question mark and asterisk characters ("?", "*") resepectively to match single or multiple characters. Field type values are folded in pattern matching.

FieldAt(TInt)

const MPresenceInfoField &

FieldAt

(

TInt

aIndex

)

const [pure virtual]

Returns a read-only presence information field from this collection.

Parameters

TInt aIndex

Zero-based index of the field to return.

FieldCount()

TInt

FieldCount

(

)

const [pure virtual]

Returns the count of presence information fields in this collection.

LookupFieldByFieldType(MPresenceInfoField *&, const TDesC8 &)

void	LookupFieldByFieldType	(	MPresenceInfoField *&	aPresenceInfoField,
			const TDesC8 &	aMatch
		)	const [pure virtual]

Looks up the field having given name.

Parameters

MPresenceInfoField *& aPresenceInfoField	On entry, contains the field object from where to start the lookup or NULL if lookup should be started from beginning of the collection. If field object given in entry is not a member of collection, lookup is started from beginning. On return, if an matching field object is found, this is set to point to the found field, else NULL. Found field object ownership is not returned to caller.
const TDesC8 & aMatch	Presence information field type match pattern. Match pattern may contain question mark and asterisk characters ("?", "*") resepectively to match single or multiple characters. Field type values are folded in pattern matching.