| class MPresenceCacheReader2 |
Interface for presence cache reader API. This interface is implemented by the Presence Cache client. Notice that an xsp id is in the form ovi: mailto:xyz@example.com
| Public Member Functions | |
|---|---|
| ~MPresenceCacheReader2 () | |
| TInt | AllBuddiesPresenceInService (const TDesC &, MPresenceCacheReadHandler2 *) |
| TInt | BuddyCountInAllServices () |
| TInt | BuddyCountInService (const TDesC &) |
| TInt | CancelRead () |
| IMPORT_C MPresenceCacheReader2 * | CreateReaderL () |
| MPresenceBuddyInfo2 * | PresenceInfoLC (const TDesC &) |
| TInt | ServicesCount () |
| TInt | SetObserverForSubscribedNotifications ( MPresenceCacheReadHandler2 *) |
| TInt | SubscribePresenceBuddyChangeL (const TDesC &) |
| void | UnSubscribePresenceBuddyChangeL (const TDesC &) |
| ~MPresenceCacheReader2 | ( | ) | [inline, virtual] |
Public destructor. Objects can be deleted through this interface.
| TInt | AllBuddiesPresenceInService | ( | const TDesC & | aServiceName, |
| MPresenceCacheReadHandler2 * | aHandler | |||
| ) | [pure virtual] | |||
Reads all presence info from cache for a given service. Returns in MPresenceCacheReadHandler2's HandlePresenceReadL.
| const TDesC & aServiceName | Service name to search from |
| MPresenceCacheReadHandler2 * aHandler | to handle async. callback |
| 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.
| 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.
| const TDesC & aServiceName | as in device's service table |
| TInt | CancelRead | ( | ) | [pure virtual] |
Cancels any async. read operation going on. After calling this method no callback will be received from asycn read method.
| IMPORT_C MPresenceCacheReader2 * | CreateReaderL | ( | ) | [static] |
Factory method to instantiate MPresenceCacheReader.
| MPresenceBuddyInfo2 * | PresenceInfoLC | ( | const TDesC & | aIdentity | ) | [pure virtual] |
Reads presence info from cache for a given identity, returns immediately.
| const TDesC & aIdentity | buddy id, identity must be in xsp id format |
| TInt | ServicesCount | ( | ) | [pure virtual] |
Returns total number services in presence cache.
| TInt | SetObserverForSubscribedNotifications | ( | MPresenceCacheReadHandler2 * | aHandler | ) | [pure virtual] |
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.
| MPresenceCacheReadHandler2 * aHandler |
| TInt | SubscribePresenceBuddyChangeL | ( | const TDesC & | aIdentity | ) | [pure virtual] |
Subscribe for given presence buddy's change in presence. An observer must be set before using this method by SetObserverForSubscribedNotifications. Notifcations are delivered through MPresenceCacheReadHandler2's HandlePresenceNotificationL
| const TDesC & aIdentity | buddy id, identity must be in xsp id format |
| void | UnSubscribePresenceBuddyChangeL | ( | const TDesC & | aIdentity | ) | [pure virtual] |
Unsubscribe for given presence buddy's change in presence. The request is ignored if invalid.
| const TDesC & aIdentity | buddy id, identity must be in xsp id format |
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.