MPresenceInfo Class Reference

class MPresenceInfo : public MXIMPBase

Interface for presence info object.

TodoInterface might be extended with new methods.

Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

~MPresenceInfo()

~MPresenceInfo ( ) [inline, virtual]

Public destructor. MPresenceInfo object can be deleted through this interface.

Member Functions Documentation

AddDevicePresenceL(MDevicePresenceInfo *)

void AddDevicePresenceL ( MDevicePresenceInfo * aDevicePresence ) [pure virtual]

Adds device presence information object.

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

Parameters

MDevicePresenceInfo * aDevicePresence New device presence value. Ownership of the argument is transfered to callee, if method succeeds without a leave.

AddServicePresenceL(MServicePresenceInfo *)

void AddServicePresenceL ( MServicePresenceInfo * aServicePresence ) [pure virtual]

Adds service presence information object.

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

Parameters

MServicePresenceInfo * aServicePresence New service presence value. Ownership of the argument is transfered to callee, if method succeeds without a leave.

DevicePresenceAt(TInt)

const MDevicePresenceInfo & DevicePresenceAt ( TInt aIndex ) const [pure virtual]

Returns a read-only device presence information object.

Parameters

TInt aIndex Zero-based index of the device presence information object to return.

DevicePresenceCount()

TInt DevicePresenceCount ( ) const [pure virtual]

Returns count of device presence information objects.

LookupServicePresenceByServiceType(MServicePresenceInfo *&, const TDesC8 &)

void LookupServicePresenceByServiceType ( MServicePresenceInfo *& aServicePresence,
const TDesC8 & aMatch
) const [pure virtual]

Looks up a read-only service presence information object, having matching service type.

Parameters

MServicePresenceInfo *& aServicePresence On entry, contains the object from where to start the lookup or NULL if lookup should be started from the beginning of the set. If object given in entry is not found from set, lookup is started from the beginning of the set. On return, if an matching object is found, this is set to point to the found object, else NULL. Found object ownership is not returned to caller.
const TDesC8 & aMatch The service type match pattern. Match pattern may contain question mark and asterisk characters ("?", "*") resepectively to match single or multiple characters. Service type are handled as folded in pattern matching.

PersonPresence()

const MPersonPresenceInfo * PersonPresence ( ) const [pure virtual]

Returns read-only person presence information object.

Returns the read-only person presence information object or NULL if person presence information not available.

PersonPresence()

MPersonPresenceInfo * PersonPresence ( ) [pure virtual]

Returns person presence information object.

Returns the person presence information object or NULL if person presence information not available.

ServicePresenceAt(TInt)

const MServicePresenceInfo & ServicePresenceAt ( TInt aIndex ) const [pure virtual]

Returns a read-only service presence information object.

Parameters

TInt aIndex Zero-based index of the service presence information object to return.

ServicePresenceCount()

TInt ServicePresenceCount ( ) const [pure virtual]

Returns count of service presence information objects.

SetPersonPresenceL(MPersonPresenceInfo *)

void SetPersonPresenceL ( MPersonPresenceInfo * aPersonPresence ) [pure virtual]

Sets person presence information object.

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

Parameters

MPersonPresenceInfo * aPersonPresence New person presence value. Ownership of the argument is transfered to callee, if method succeeds without a leave.