MProtocolPresencePublishingDataHost Class Reference

class MProtocolPresencePublishingDataHost : public MXIMPBase

Interface for managing cached presence publication information.

Interface is used by protocol adaptations to manage presence publication 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

~MProtocolPresencePublishingDataHost()

~MProtocolPresencePublishingDataHost ( ) [protected, inline, virtual]

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

Member Functions Documentation

HandlePresenceWatcherListL(MXIMPObjectCollection *)

TXIMPRequestId HandlePresenceWatcherListL ( MXIMPObjectCollection * aWatcherList ) [pure virtual]

Notifies XIMP Framework from presence watcher list contents.

Protocol adaptation implementation can call this method to notify XIMP Framework from complete presence watcher list content. XIMP Framework calculates the changes (new and disappeared watcher 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 * aWatcherList MXIMPObjectCollection object containing zero or more MPresenceWatcherInfo objects. Each contained MPresenceWatcherInfo shall present single presence watcher entry in the list of presence watchers.

HandleSubscribedOwnPresenceL(MPresenceInfo *)

TXIMPRequestId HandleSubscribedOwnPresenceL ( MPresenceInfo * aPresenceInfo ) [pure virtual]

Notifies XIMP Framework from subscribed user own presence information.

Protocol adaptation implementation can call this method to notify XIMP Framework from user own subscribed presence information. XIMP Framework updates its cached user own presence status, 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

MPresenceInfo * aPresenceInfo MPresenceInfo object containing new subscribed own presence information .

OwnPresenceDataSubscriptionState()

const MXIMPDataSubscriptionState & OwnPresenceDataSubscriptionState ( ) const [pure virtual]

Gets data subscription state for own presence information.

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

PresenceWatcherListDataSubscriptionState()

const MXIMPDataSubscriptionState & PresenceWatcherListDataSubscriptionState ( ) const [pure virtual]

Gets data subscription state for presence watcher list.

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

SetOwnPresenceDataSubscriptionStateL(MXIMPDataSubscriptionState *, MXIMPStatus *)

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

Updates data subscription state for presence block list.

Updates data subscription state for own presence information. XIMP Framework calculates the subscription state change, from previous own presence information 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 own presence information.
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.

SetPresenceWatcherListDataSubscriptionStateL(MXIMPDataSubscriptionState *, MXIMPStatus *)

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

Updates data subscription state for presence watcher list.

Updates data subscription state for presence watcher list. XIMP Framework calculates the subscription state change, from previous presence watcher 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 watcher 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.