Collapse all Symbian^3 Product Developer Library

MProtocolPresenceAuthorization Class Reference

class MProtocolPresenceAuthorization : public MXIMPBase

Interface for presence protocol authorization 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 presence authorization 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

MProtocolPresenceAuthorization
- MXIMPBase

Public Member Functions
void	DoBlockPresenceForPresentityL(const MXIMPIdentity &, TXIMPRequestId)
void	DoCancelPresenceBlockFromPresentityL(const MXIMPIdentity &, TXIMPRequestId)
void	DoGrantPresenceForEveryoneL(const MPresenceInfoFilter &, TXIMPRequestId)
void	DoGrantPresenceForPresentityGroupMembersL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)
void	DoGrantPresenceForPresentityL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)
void	DoSubscribePresenceBlockListL(TXIMPRequestId)
void	DoSubscribePresenceGrantRequestListL(TXIMPRequestId)
void	DoUnsubscribePresenceBlockListL(TXIMPRequestId)
void	DoUnsubscribePresenceGrantRequestListL(TXIMPRequestId)
void	DoUpdatePresenceGrantPifForEveryoneL(const MPresenceInfoFilter &, TXIMPRequestId)
void	DoUpdatePresenceGrantPifForPresentityGroupMembersL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)
void	DoUpdatePresenceGrantPifForPresentityL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)
void	DoWithdrawPresenceGrantFromEveryoneL(TXIMPRequestId)
void	DoWithdrawPresenceGrantFromPresentityGroupMembersL(const MXIMPIdentity &, TXIMPRequestId)
void	DoWithdrawPresenceGrantFromPresentityL(const MXIMPIdentity &, TXIMPRequestId)

Protected Member Functions
	~MProtocolPresenceAuthorization()

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

~MProtocolPresenceAuthorization()

~MProtocolPresenceAuthorization

(

)

[protected, inline, virtual]

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

Member Functions Documentation

DoBlockPresenceForPresentityL(const MXIMPIdentity &, TXIMPRequestId)

void	DoBlockPresenceForPresentityL	(	const MXIMPIdentity &	aPresentityId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to block the identified presentity from seeing presence information produced by this presence connection.

After blocking, identified presentity can't anymore access the user own presence information.

Parameters

const MXIMPIdentity & aPresentityId	Identification of the presentity for which presence information access to block.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoCancelPresenceBlockFromPresentityL(const MXIMPIdentity &, TXIMPRequestId)

void	DoCancelPresenceBlockFromPresentityL	(	const MXIMPIdentity &	aPresentityId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to cancel existing presence information block from the identified presentity.

Parameters

const MXIMPIdentity & aPresentityId	Identification of the presentity of which presence information block to cancel.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoGrantPresenceForEveryoneL(const MPresenceInfoFilter &, TXIMPRequestId)

void	DoGrantPresenceForEveryoneL	(	const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to allow everyone to see specified presence information.

Parameters

const MPresenceInfoFilter & aPif	Presence information filter indicating the allowed presence information.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoGrantPresenceForPresentityGroupMembersL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)

void	DoGrantPresenceForPresentityGroupMembersL	(	const MXIMPIdentity &	aGroupId,
			const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to allow the identified presentity group members to see specified presence information.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group for which members to allow presence information.
const MPresenceInfoFilter & aPif	Presence information filter indicating the allowed presence information.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoGrantPresenceForPresentityL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)

void	DoGrantPresenceForPresentityL	(	const MXIMPIdentity &	aPresentityId,
			const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to allow the identified presentity to see specified presence information.

Parameters

const MXIMPIdentity & aPresentityId	Identification of the presentity to which to allow presence information access.
const MPresenceInfoFilter & aPif	Presence information filter indicating the allowed presence information.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoSubscribePresenceBlockListL(TXIMPRequestId)

void

DoSubscribePresenceBlockListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to subscribe presence block list from remote service.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoSubscribePresenceGrantRequestListL(TXIMPRequestId)

void

DoSubscribePresenceGrantRequestListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to subscribe presence grant request list from remote service.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoUnsubscribePresenceBlockListL(TXIMPRequestId)

void

DoUnsubscribePresenceBlockListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to terminate presence block list subscription.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoUnsubscribePresenceGrantRequestListL(TXIMPRequestId)

void

DoUnsubscribePresenceGrantRequestListL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to terminate presence grant request list subscription.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoUpdatePresenceGrantPifForEveryoneL(const MPresenceInfoFilter &, TXIMPRequestId)

void	DoUpdatePresenceGrantPifForEveryoneL	(	const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to update presence information filter (PIF) for already existing presence grant.

Parameters

const MPresenceInfoFilter & aPif	Indicates the new set of presence information to allow for the presentity. Given set may be "wider" or "narrower" than the already allowed one.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoUpdatePresenceGrantPifForPresentityGroupMembersL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)

void	DoUpdatePresenceGrantPifForPresentityGroupMembersL	(	const MXIMPIdentity &	aGroupId,
			const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to update presence information filter (PIF) for already existing presentity group members presence grant.

Parameters

const MXIMPIdentity & aGroupId	Identification of the presentity group for which members presence grant PIF to update.
const MPresenceInfoFilter & aPif	Indicates the new set of presence information to allow for the presentities. Given set may be "wider" or "narrower" than the already allowed one.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoUpdatePresenceGrantPifForPresentityL(const MXIMPIdentity &, const MPresenceInfoFilter &, TXIMPRequestId)

void	DoUpdatePresenceGrantPifForPresentityL	(	const MXIMPIdentity &	aPresentityId,
			const MPresenceInfoFilter &	aPif,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to update presence information filter (PIF) for already existing presence grant.

Parameters

const MXIMPIdentity & aPresentityId	Identification of the presentity which presence grant PIF to update.
const MPresenceInfoFilter & aPif	Indicates the new set of presence information to allow for the presentity. Given set may be "wider" or "narrower" than the already allowed one.
TXIMPRequestId aReqId	Request ID identifying the issued request.

DoWithdrawPresenceGrantFromEveryoneL(TXIMPRequestId)

void

DoWithdrawPresenceGrantFromEveryoneL

(

TXIMPRequestId

aReqId

)

[pure virtual]

Requests the protocol to withdraw existing presence information grant.

Parameters

TXIMPRequestId aReqId

Request ID identifying the issued request.

DoWithdrawPresenceGrantFromPresentityGroupMembersL(const MXIMPIdentity &, TXIMPRequestId)

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

Requests the protocol to withdraw existing presentity group members presence information grant.

Parameters

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

DoWithdrawPresenceGrantFromPresentityL(const MXIMPIdentity &, TXIMPRequestId)

void	DoWithdrawPresenceGrantFromPresentityL	(	const MXIMPIdentity &	aPresentityId,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to withdraw existing presence information grant.

Parameters

const MXIMPIdentity & aPresentityId	Identification of the presentity which presence grant to withdraw.
TXIMPRequestId aReqId	Request ID identifying the issued request.