MPresenceCacheReader Class Reference
| class MPresenceCacheReader |
Interface for presence cache reader API. This interface is implemented by the XIMP Framework Presence Cache client. Clients must call REComSession::FinalClose() from their destructors. Notice that an xsp id is in the form ovi:mailto:xyz@example.com
Constructor & Destructor Documentation
MPresenceCacheReader()
| MPresenceCacheReader | ( | ) | [protected, inline] |
Default constructor to zero initialize the iEcomDtorID member.
~MPresenceCacheReader()
| ~MPresenceCacheReader | ( | ) | [inline, virtual] |
Public destructor. Objects can be deleted through this interface.
Member Functions Documentation
AllBuddiesPresenceInService(const TDesC &, MPresCacheReadHandler *)
Reads all presence info from cache for a given service. Returns in MPresCacheReadHandler's HandlePresenceReadL.
BuddyCountInAllServices()
|
TInt
| BuddyCountInAllServices | ( | ) | [pure virtual] |
Returns total number of buddies stored in presence cache. It includes all services, probably useful while deciding performance overheads or informing to the user.
BuddyCountInService(const TDesC &)
|
TInt
| BuddyCountInService | ( | const TDesC & | aServiceName | ) | [pure virtual] |
Returns total number of buddies (presence infos) stored in a specific service in presence cache. It includes only the given service.
Parameters
| const TDesC & aServiceName | as in device's service table |
CancelRead()
|
TInt
| CancelRead | ( | ) | [pure virtual] |
Returns all service names present in presence cache.
Service names are returned here, ownership to caller. Cancels any async. read operation going on. After calling this method no callback will be received from asycn read method.
NewIdentityLC()
Instantiates new identity object.
-
leave
- KErrNoMemory if failed to allocate memory.
PresenceInfoLC(const MXIMPIdentity &)
Reads presence info from cache for a given identity, returns immediately.
Parameters
| const MXIMPIdentity & aIdentity | buddy id, identity must be in xsp id format |
ServicesCount()
|
TInt
| ServicesCount | ( | ) | [pure virtual] |
Returns total number services in presence cache.
SetObserverForSubscribedNotifications(MPresCacheReadHandler *)
Sets the observer to receive Presence Buddy Change notifications. Observer must be set before using SubscribePresenceBuddyChangeL. If client changes the observer using this method, all the notifications related to existing and new subscriptions will be delivered to the new observer.
SubscribePresenceBuddyChangeL(const MXIMPIdentity &)
Subscribe for given presence buddy's change in presence. An observer must be set before using this method by SetObserverForSubscribedNotifications. Notifcations are delivered through MPresCacheReadHandler's HandlePresenceNotificationL
-
leave
- Only in system error cases e.g. if failed to allocate memory.
Parameters
| const MXIMPIdentity & aIdentity | buddy id, identity must be in xsp id format |
UnSubscribePresenceBuddyChangeL(const MXIMPIdentity &)
| void | UnSubscribePresenceBuddyChangeL | ( | const MXIMPIdentity & | aIdentity | ) | [pure virtual] |
Unsubscribe for given presence buddy's change in presence. The request is ignored if invalid.
-
leave
- Only in system error cases e.g. if failed to allocate memory.
Parameters
| const MXIMPIdentity & aIdentity | buddy id, identity must be in xsp id format |
Member Data Documentation
TUid
iEcomDtorID
|
TUid
| iEcomDtorID | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.