Collapse all Symbian^3 Product Developer Library

MPresentityGroups Class Reference

class MPresentityGroups : public MXIMPBase

Presentity group handling interface for clients use. Interface is implemented by the XIMP Framework.

MPresentityGroups provides services for XIMP Framework clients to manage presentity groups and presentity group members. It provides also services to subscribe notifications from presentity group list changes and from individual presentity group changes.

Client can retrieve MPresentityGroups interface from MXIMPContext interface.

Since: S60 v3.2

Inherits from

MPresentityGroups
- MXIMPBase

Public Member Functions
TXIMPRequestId	AddPresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &)
TXIMPRequestId	CreatePresentityGroupL(const MXIMPIdentity &, const TDesC16 &)
TXIMPRequestId	DeletePresentityGroupL(const MXIMPIdentity &)
TXIMPRequestId	RemovePresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &)
TXIMPRequestId	SubscribePresentityGroupContentL(const MXIMPIdentity &)
TXIMPRequestId	SubscribePresentityGroupListL()
TXIMPRequestId	UnsubscribePresentityGroupContentL(const MXIMPIdentity &)
TXIMPRequestId	UnsubscribePresentityGroupListL()
TXIMPRequestId	UpdatePresentityGroupDisplayNameL(const MXIMPIdentity &, const TDesC16 &)
TXIMPRequestId	UpdatePresentityGroupMemberDisplayNameL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &)

Protected Member Functions
	~MPresentityGroups()

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

Inherited Enumerations
	MXIMPBase:@65
	MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MPresentityGroups()

~MPresentityGroups

(

)

[protected, inline, virtual]

Protected destructor. Object instancies can't be deleted via this interface.

Member Functions Documentation

AddPresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &)

TXIMPRequestId	AddPresentityGroupMemberL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId,
			const TDesC16 &	aMemberDisplayName
		)	[pure virtual]

Requests the protocol to add new member to identified presentity group.

Note: Remote service may alter given member and display name. Altered ID and display names are signalled back to client through MXIMPRequestCompleteEvent.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group where to add new member.
const MXIMPIdentity & aMemberId	Identification of the new member.
const TDesC16 & aMemberDisplayName	Display name for the added member.

CreatePresentityGroupL(const MXIMPIdentity &, const TDesC16 &)

TXIMPRequestId	CreatePresentityGroupL	(	const MXIMPIdentity &	aGroupId,
			const TDesC16 &	aDisplayName
		)	[pure virtual]

Creates presentity group.

Note: Remote service may alter given presentity group ID and display name. Altered ID and display names are signalled back to client through MXIMPRequestCompleteEvent.

Parameters

const MXIMPIdentity & aGroupId	Identification for presentity group.
const TDesC16 & aDisplayName	Presentity group display name.

DeletePresentityGroupL(const MXIMPIdentity &)

TXIMPRequestId

DeletePresentityGroupL

(

const MXIMPIdentity &

aGroupId

)

[pure virtual]

Deletes presentity group.

Parameters

const MXIMPIdentity & aGroupId

Identification for presentity group.

RemovePresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &)

TXIMPRequestId	RemovePresentityGroupMemberL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId
		)	[pure virtual]

Requests the XIMPFw to remove member from identified presentity group.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group from where to remove member.
const MXIMPIdentity & aMemberId	Identification of the member to remove.

SubscribePresentityGroupContentL(const MXIMPIdentity &)

TXIMPRequestId

SubscribePresentityGroupContentL

(

const MXIMPIdentity &

aGroupId

)

[pure virtual]

Subscribes presentity group content notifications.

Parameters

const MXIMPIdentity & aGroupId

Identification for presentity group for which to subscribe content notifications.

SubscribePresentityGroupListL()

TXIMPRequestId

SubscribePresentityGroupListL

(

)

[pure virtual]

Subscribes presentity group list notifications.

UnsubscribePresentityGroupContentL(const MXIMPIdentity &)

TXIMPRequestId

UnsubscribePresentityGroupContentL

(

const MXIMPIdentity &

aGroupId

)

[pure virtual]

Unsubscribes presentity group content notifications.

Parameters

const MXIMPIdentity & aGroupId

Identification for presentity group for which content notification subscription to terminate.

UnsubscribePresentityGroupListL()

TXIMPRequestId

UnsubscribePresentityGroupListL

(

)

[pure virtual]

Unsubscribes presentity group list notifications.

UpdatePresentityGroupDisplayNameL(const MXIMPIdentity &, const TDesC16 &)

TXIMPRequestId	UpdatePresentityGroupDisplayNameL	(	const MXIMPIdentity &	aGroupId,
			const TDesC16 &	aDisplayName
		)	[pure virtual]

Updates presentity group display name.

Note: Remote service may alter given presentity group display name. Altered display name is signalled back to client through MXIMPRequestCompleteEvent.

Parameters

const MXIMPIdentity & aGroupId	Identification for presentity group.
const TDesC16 & aDisplayName	New display name for the presentity group.

UpdatePresentityGroupMemberDisplayNameL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &)

TXIMPRequestId	UpdatePresentityGroupMemberDisplayNameL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId,
			const TDesC16 &	aMemberDisplayName
		)	[pure virtual]

Requests the XIMPFw to update presentity group member display name.

Note: Remote service may alter given presentity group member display name. Altered display name is signalled back to client through MXIMPRequestCompleteEvent.

Parameters

const MXIMPIdentity & aGroupId	Identification for presentity group.
const MXIMPIdentity & aMemberId	Identification of the member which display name to update.
const TDesC16 & aMemberDisplayName	New display name for the member.