MPresenceWatcherListEvent Class Reference

class MPresenceWatcherListEvent : public MXIMPBase

Event interface for presence watcher list content.

This interface is implemented by the XIMP Framework and event object is signalled to registered client observers through MXIMPContextObserver observer interface. This event notifies clients about changes in presence watcher list content.

Clients subscribe for this event with MPresencePublishing::SubscribePresenceWatcherListL().

XIMP Framework signals this event when:
  • New subscribed data is received from protocol.

  • Data item data subscription status is updated by protocol adaptation.

  • When client unsubscribes the data item.

  • XIMP Framework generates initial data notification to client automatically after clients subscription, when the initial data comes available from protocol.

Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

~MPresenceWatcherListEvent()

~MPresenceWatcherListEvent ( ) [protected, inline, virtual]

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

Member Functions Documentation

CurrentWatcher(TInt)

const MPresenceWatcherInfo & CurrentWatcher ( TInt aIndex ) const [pure virtual]

Gets presence watcher entry by index.

Note that, current information is signalled only when the client refreshes the event data from XIMP Framework cache, by re-issuing the data subscription.

Parameters

TInt aIndex The index of the presence watcher entry to get.

CurrentWatchersCount()

TInt CurrentWatchersCount ( ) const [pure virtual]

Gets count of current presence watcher entries.

Note that, valid "current information" is signalled only when the client refreshes the event data from XIMP Framework cache, by re-issuing the data subscription. In other cases, just plain "delta information" is signalled to client.

DataSubscriptionState()

const MXIMPDataSubscriptionState & DataSubscriptionState ( ) const [pure virtual]

Returns subscription state object holding information about data items data subscription state.

DisappearedWatcher(TInt)

const MPresenceWatcherInfo & DisappearedWatcher ( TInt aIndex ) const [pure virtual]

Gets presence watcher entry by index.

Parameters

TInt aIndex The index of the presence watcher entry to get.

DisappearedWatchersCount()

TInt DisappearedWatchersCount ( ) const [pure virtual]

Gets count of dissappeared presence watcher entries.

NewWatcher(TInt)

const MPresenceWatcherInfo & NewWatcher ( TInt aIndex ) const [pure virtual]

Gets presence watcher entry by index.

Parameters

TInt aIndex The index of the presence watcher entry to get.

NewWatchersCount()

TInt NewWatchersCount ( ) const [pure virtual]

Gets count of new presence watcher entries.