Collapse all Symbian^3 Product Developer Library

MPresenceInfoFilter Class Reference

class MPresenceInfoFilter : public MXIMPBase

Interface for presence info filter object.

Presence information filter is used to define requested presence information in presence subscriptions and granted presence information in presence grants.

Filtering is "inclusive": data is passed through if it matches the given filtering criteria. Data with keys not matching to the filtering criteria will be skipped by the filter.

The Accept*FilterL methods can be called many times, to accept multiple distinct fields. Wildcards "*" and "?" are allowed within the strings.

TodoInterface will be extended.

Since: S60 v3.2

Inherits from

MPresenceInfoFilter
- MXIMPBase

Public Member Functions
	~MPresenceInfoFilter()
void	AcceptDeviceFilterL(const TDesC8 &, const TDesC8 &)
void	AcceptPersonFilterL(const TDesC8 &)
void	AcceptServiceFilterL(const TDesC8 &, const TDesC8 &)
TBool	MatchDeviceFilterL(const TDesC8 &, const TDesC8 &)
TBool	MatchPersonFilter(const TDesC8 &)
TBool	MatchServiceFilterL(const TDesC8 &, 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

~MPresenceInfoFilter()

~MPresenceInfoFilter

(

)

[inline, virtual]

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

Member Functions Documentation

AcceptDeviceFilterL(const TDesC8 &, const TDesC8 &)

void	AcceptDeviceFilterL	(	const TDesC8 &	aDeviceName,
			const TDesC8 &	aFieldName
		)	[pure virtual]

Set filter for the device presence component. Wildcards "*" and "?" are allowed.

Parameters

const TDesC8 & aDeviceName	The device name
const TDesC8 & aFieldName	The field name within the given device info

AcceptPersonFilterL(const TDesC8 &)

void

AcceptPersonFilterL

(

const TDesC8 &

aFieldName

)

[pure virtual]

Set filter for a field in the person presence component. Wildcards "*" and "?" are allowed.

Parameters

const TDesC8 & aFieldName

The field name within the person info

AcceptServiceFilterL(const TDesC8 &, const TDesC8 &)

void	AcceptServiceFilterL	(	const TDesC8 &	aServiceName,
			const TDesC8 &	aFieldName
		)	[pure virtual]

Set filter for the service presence component. Wildcards "*" and "?" are allowed.

Parameters

const TDesC8 & aServiceName	The service type
const TDesC8 & aFieldName	The field name within the given service info

MatchDeviceFilterL(const TDesC8 &, const TDesC8 &)

TBool	MatchDeviceFilterL	(	const TDesC8 &	aDeviceName,
			const TDesC8 &	aFieldName
		)	const [pure virtual]

Find out if the filter accepts the field in a given device info.

Parameters

const TDesC8 & aDeviceName	The name of the device info to check
const TDesC8 & aFieldName	The field to check

MatchPersonFilter(const TDesC8 &)

TBool

MatchPersonFilter

(

const TDesC8 &

aFieldName

)

const [pure virtual]

Try to match given field type against the filters for the person presence component.

Parameters

const TDesC8 & aFieldName

The field to check

MatchServiceFilterL(const TDesC8 &, const TDesC8 &)

TBool	MatchServiceFilterL	(	const TDesC8 &	aServiceName,
			const TDesC8 &	aFieldName
		)	const [pure virtual]

Find out if the filter accepts the field in a given service info.

Parameters

const TDesC8 & aServiceName	The name of the service info to check
const TDesC8 & aFieldName	The field name to check