MProtocolPresenceAuthorizationDataHost Class Reference

class MProtocolPresenceAuthorizationDataHost : public MXIMPBase

Interface for managing cached presence authorization information.

Interface is used by protocol adaptations to manage presence authorization related information in XIMP Framework internal data cache.

This interface is implemented by XIMP Framework. Protocol adaptation can obtain reference to this interface from MXIMPProtocolConnectionHost interface.

For each separated protocol connection, protocol adaptation must use the specific MProtocolPresentityGroupsDataHost instance, what is received from the connection specific MXIMPProtocolConnectionHost instance.

Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

~MProtocolPresenceAuthorizationDataHost()

~MProtocolPresenceAuthorizationDataHost ( ) [protected, inline, virtual]

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

Member Functions Documentation

HandlePresenceBlockCanceledL(MXIMPIdentity *)

TXIMPRequestId HandlePresenceBlockCanceledL ( MXIMPIdentity * aBlockedEntityId ) [pure virtual]

Notifies XIMP Framework from cancellation of existing presence block entry.

Protocol adaptation can call this method to notify XIMP Framework from cancellation of existing presence block entry. XIMP Framework calculates the change, from previous presence block list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aBlockedEntityId Identity of the presence block entry which to remove from presence block list.

HandlePresenceBlockListL(MXIMPObjectCollection *)

TXIMPRequestId HandlePresenceBlockListL ( MXIMPObjectCollection * aBlockList ) [pure virtual]

Notifies XIMP Framework from presence block list contents.

Protocol adaptation implementation can call this method to notify XIMP Framework from complete presence block list content. XIMP Framework calculates the changes (new and removed block entries) from previous presence block list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the object collection and all objects contained within, if the method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPObjectCollection * aBlockList MXIMPObjectCollection object containing zero or more MPresenceBlockInfo objects. Each contained MPresenceBlockInfo shall present single presence block entry in the presence block list.

HandlePresenceBlockedL(MPresenceBlockInfo *)

TXIMPRequestId HandlePresenceBlockedL ( MPresenceBlockInfo * aBlockInfo ) [pure virtual]

Notifies XIMP Framework from new presence block entry.

Protocol adaptation implementation can call this method to notify XIMP Framework from new presence block entry. XIMP Framework calculates the change, from previous presence block list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MPresenceBlockInfo * aBlockInfo MPresenceBlockInfo object containing presence block entrys information.

HandlePresenceGrantRequestListL(MXIMPObjectCollection *)

TXIMPRequestId HandlePresenceGrantRequestListL ( MXIMPObjectCollection * aGrantRequestList ) [pure virtual]

Notifies XIMP Framework from presence grant request list contents.

Protocol adaptation implementation can call this method to notify XIMP Framework from complete presence grant request list content. XIMP Framework calculates the changes (new and obsoleted requests) from previous presence grant request list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the object collection and all objects contained within, if the method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPObjectCollection * aGrantRequestList MXIMPObjectCollection object containing zero or more MPresenceGrantRequestInfo objects. Each contained MPresenceGrantRequestInfo shall present single presence grant request entry in the list of presence grant requests.

HandlePresenceGrantRequestObsoletedL(MXIMPIdentity *)

TXIMPRequestId HandlePresenceGrantRequestObsoletedL ( MXIMPIdentity * aGrantRequestor ) [pure virtual]

Notifies XIMP Framework that existing presence grant request is obsoleted.

Notifies XIMP Framework that existing presence grant request is obsoleted and thus it needs be removed from presence grant request list. XIMP Framework calculates the change, from previous presence grant request list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aGrantRequestor Identity of the presence grant requestor, which presence grant request needs to be removed from presence grant request list.

HandlePresenceGrantRequestReceivedL(MPresenceGrantRequestInfo *)

TXIMPRequestId HandlePresenceGrantRequestReceivedL ( MPresenceGrantRequestInfo * aGrantRequest ) [pure virtual]

Notifies XIMP Framework from new presence grant request.

Protocol adaptation implementation can call this method to notify XIMP Framework from new presence grant request. XIMP Framework calculates the change, from previous presence grant request list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MPresenceGrantRequestInfo * aGrantRequest MPresenceGrantRequestInfo object holding information about new presence grant request entry.

PresenceBlockDataSubscriptionState()

const MXIMPDataSubscriptionState & PresenceBlockDataSubscriptionState ( ) const [pure virtual]

Gets data subscription state for presence block list.

Protocol adaptation can call this method to retrieve presence block list current data subscription state. Protocol adaptation can use data subscription state information, to optimize its own processing and network trafic amount.

PresenceGrantRequestDataSubscriptionState()

const MXIMPDataSubscriptionState & PresenceGrantRequestDataSubscriptionState ( ) const [pure virtual]

Gets data subscription state for presence grant request list.

Protocol adaptation can call this method to retrieve presence grant request list current data subscription state. Protocol adaptation can use data subscription state information, to optimize its own processing and network trafic amount.

SetPresenceBlockDataSubscriptionStateL(MXIMPDataSubscriptionState *, MXIMPStatus *)

TXIMPRequestId SetPresenceBlockDataSubscriptionStateL ( MXIMPDataSubscriptionState * aSubscriptionState,
MXIMPStatus * aStatus
) [pure virtual]

Updates data subscription state for presence block list.

Updates data subscription state for presence block list. XIMP Framework calculates the subscription state change, from previous presence block list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL subscription state argument was provided.

Parameters

MXIMPDataSubscriptionState * aSubscriptionState New data subscription state for presence block list.
MXIMPStatus * aStatus Optional status object describing the the reason, why protocol adaptation updated data item subscription state. Given status object is passed to clients through data item specific data change event. NULL value is accepted.

SetPresenceGrantRequestDataSubscriptionStateL(MXIMPDataSubscriptionState *, MXIMPStatus *)

TXIMPRequestId SetPresenceGrantRequestDataSubscriptionStateL ( MXIMPDataSubscriptionState * aSubscriptionState,
MXIMPStatus * aStatus
) [pure virtual]

Updates data subscription state for presence grant request list.

Updates data subscription state for presence grant request list. XIMP Framework calculates the subscription state change, from previous presence grant request list content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL subscription state argument was provided.

Parameters

MXIMPDataSubscriptionState * aSubscriptionState New data subscription state for presence grant request list.
MXIMPStatus * aStatus Optional status object describing the the reason, why protocol adaptation updated data item subscription state. Given status object is passed to clients through data item specific data change event. NULL value is accepted.