Collapse all Symbian^3 Product Developer Library

MProtocolPresentityGroups Class Reference

class MProtocolPresentityGroups : public MXIMPBase

Interface for presence protocol presentity groups object. Interface must be implemented by a XIMP Framework protocol plug-ins.

This interface defines actions that XIMP Framework requests from a presence protocol connection to execute presentity groups related tasks.

Protocol implementation must route requests received through this interface, to same remote presence service destination, as where the parent MXIMPProtocolConnection is connected. (Here the parent MXIMPProtocolConnection means the protocol connection instance from where this interface instance was retrieved.)

MXIMPProtocolConnection

Since: S60 v3.2

Inherits from

MProtocolPresentityGroups
- MXIMPBase

Public Member Functions
void	DoAddPresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)
void	DoCreatePresentityGroupL(const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)
void	DoDeletePresentityGroupL(const MXIMPIdentity &, TXIMPRequestId)
void	DoRemovePresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, TXIMPRequestId)
void	DoSubscribePresentityGroupContentL(const MXIMPIdentity &, TXIMPRequestId)
void	DoSubscribePresentityGroupListL(TXIMPRequestId)
void	DoUnsubscribePresentityGroupContentL(const MXIMPIdentity &, TXIMPRequestId)
void	DoUnsubscribePresentityGroupListL(TXIMPRequestId)
void	DoUpdatePresentityGroupDisplayNameL(const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)
void	DoUpdatePresentityGroupMemberDisplayNameL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)

Protected Member Functions
	~MProtocolPresentityGroups()

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

~MProtocolPresentityGroups()

~MProtocolPresentityGroups

(

)

[protected, inline, virtual]

Protected destructor. MProtocolPresentityGroups instancies can't be destroyed via this interface.

Member Functions Documentation

DoAddPresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)

void	DoAddPresentityGroupMemberL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId,
			const TDesC16 &	aMemberDisplayName,
			TXIMPRequestId	aReqId
		)	[pure virtual]

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

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.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoCreatePresentityGroupL(const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)

void	DoCreatePresentityGroupL	(	const MXIMPIdentity &	aGroupId,
			const TDesC16 &	aDisplayName,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to create new presentity group to remote service.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group to create.
const TDesC16 & aDisplayName	Display name for the created presentity group.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoDeletePresentityGroupL(const MXIMPIdentity &, TXIMPRequestId)

void	DoDeletePresentityGroupL	(	const MXIMPIdentity &	aGroupId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to delete existing presentity group from remote service.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group to delete.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoRemovePresentityGroupMemberL(const MXIMPIdentity &, const MXIMPIdentity &, TXIMPRequestId)

void	DoRemovePresentityGroupMemberL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol 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.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoSubscribePresentityGroupContentL(const MXIMPIdentity &, TXIMPRequestId)

void	DoSubscribePresentityGroupContentL	(	const MXIMPIdentity &	aGroupId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to subscribe presentity group content from remote service.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group of which content to subscribe.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoSubscribePresentityGroupListL(TXIMPRequestId)

void

DoSubscribePresentityGroupListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to subscribe presentity group list content from remote service.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoUnsubscribePresentityGroupContentL(const MXIMPIdentity &, TXIMPRequestId)

void	DoUnsubscribePresentityGroupContentL	(	const MXIMPIdentity &	aGroupId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to terminate presentity group content subscription.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group of which content subscribtion to terminate.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoUnsubscribePresentityGroupListL(TXIMPRequestId)

void

DoUnsubscribePresentityGroupListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to terminate presentity group list content subscription.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoUpdatePresentityGroupDisplayNameL(const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)

void	DoUpdatePresentityGroupDisplayNameL	(	const MXIMPIdentity &	aGroupId,
			const TDesC16 &	aDisplayName,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to update existing presentity group display name on remote service.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group which display name to update.
const TDesC16 & aDisplayName	New display name for the presentity group.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoUpdatePresentityGroupMemberDisplayNameL(const MXIMPIdentity &, const MXIMPIdentity &, const TDesC16 &, TXIMPRequestId)

void	DoUpdatePresentityGroupMemberDisplayNameL	(	const MXIMPIdentity &	aGroupId,
			const MXIMPIdentity &	aMemberId,
			const TDesC16 &	aMemberDisplayName,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to update presentity group member display name.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group of which member display name to update.
const MXIMPIdentity & aMemberId	Identification of the member which display name to update.
const TDesC16 & aMemberDisplayName	New display name for the member.
TXIMPRequestId aReqId	Request ID identifying the issued request.