Collapse all Symbian^3 Product Developer Library

MPresenceCacheWriter Class Reference

class MPresenceCacheWriter

Interface for presence cache writer 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

Since: S60 v3.2

Public Member Functions
	~MPresenceCacheWriter()
TInt	CancelWrite()
TInt	DeletePresenceL(const MXIMPIdentity &)
TInt	DeleteService(const TDesC &)
MPresenceBuddyInfo *	NewBuddyPresenceInfoLC()
MXIMPIdentity *	NewIdentityLC()
MPresenceCacheWriter *	NewL()
MPresenceBuddyInfoList *	NewPresenceBuddyInfoListLC(const TDesC &)
MPresenceInfo *	NewPresenceInfoLC()
MPresenceObjectFactory &	PresenceObjectFactory()
TInt	WritePresenceL(const MPresenceBuddyInfo *)
TInt	WritePresenceL(const MPresenceBuddyInfoList , MPresCacheWriteHandler )

Protected Member Functions
	MPresenceCacheWriter()

Private Attributes
TUid	iEcomDtorID

Constructor & Destructor Documentation

MPresenceCacheWriter()

MPresenceCacheWriter

(

)

[protected, inline]

Default constructor to zero initialize the iEcomDtorID member.

~MPresenceCacheWriter()

~MPresenceCacheWriter

(

)

[inline, virtual]

Public destructor. Objects can be deleted through this interface.

Member Functions Documentation

CancelWrite()

TInt

CancelWrite

(

)

[pure virtual]

Cancels any async. write operation going on. After calling this method no callback will be received from asycn write method.

DeletePresenceL(const MXIMPIdentity &)

TInt

DeletePresenceL

(

const MXIMPIdentity &

aIdentity

)

[pure virtual]

Deletes all presence related to given xsp identity. Leaves only in system errors.

Parameters

const MXIMPIdentity & aIdentity

DeleteService(const TDesC &)

TInt

DeleteService

(

const TDesC &

aServiceName

)

[pure virtual]

Delete all buddies presence associated with given service.

Parameters

const TDesC & aServiceName

service name as in sp table

NewBuddyPresenceInfoLC()

MPresenceBuddyInfo *

NewBuddyPresenceInfoLC

(

)

[pure virtual]

Instantiates new buddy presence info object.

leave: KErrNoMemory if failed to allocate memory.

NewIdentityLC()

MXIMPIdentity *

NewIdentityLC

(

)

[pure virtual]

Instantiates new identity object.

leave: KErrNoMemory if failed to allocate memory.

NewL()

MPresenceCacheWriter *

NewL

(

)

[static, inline]

Factory method to instantiate MPresenceCacheWriter through the ECom.

NewPresenceBuddyInfoListLC(const TDesC &)

MPresenceBuddyInfoList *

NewPresenceBuddyInfoListLC

(

const TDesC &

aServiceName

)

[pure virtual]

Instantiates new buddy presence info list object.

leave: KErrNoMemory if failed to allocate memory.

Parameters

const TDesC & aServiceName

service name for this list, if set to KNullDesC the list can be appended with identities from different services

NewPresenceInfoLC()

MPresenceInfo *

NewPresenceInfoLC

(

)

[pure virtual]

Instantiates new presence info object.

leave: KErrNoMemory if failed to allocate memory.

PresenceObjectFactory()

MPresenceObjectFactory &

PresenceObjectFactory

(

)

const [pure virtual]

Instantiates new Presence object Factory object. With this factory presence related ximp structures can be created.

WritePresenceL(const MPresenceBuddyInfo *)

TInt

WritePresenceL

(

const MPresenceBuddyInfo *

aPresenceBuddyInfo

)

[pure virtual]

Writes presence info to cache for a given buddy. Leaves only in system errors.

Parameters

const MPresenceBuddyInfo * aPresenceBuddyInfo

contains xsp identity and presence

WritePresenceL(const MPresenceBuddyInfoList , MPresCacheWriteHandler )

TInt	WritePresenceL	(	const MPresenceBuddyInfoList *	aBuddyPresenceInfos,
			MPresCacheWriteHandler *	aHandler
		)	[pure virtual]

Writes buddy presence info objects to cache. Returns in MPresCacheWriteHandler's HandlePresenceWriteL. Provide a null pointer to receive no call back. Leaves only in system errors.

Parameters

const MPresenceBuddyInfoList * aBuddyPresenceInfos	presence infos for all buddies. Ownership remains to caller.
MPresCacheWriteHandler * aHandler

Member Data Documentation

TUid iEcomDtorID

TUid

iEcomDtorID

[private]

MPresenceCacheWriter Class Reference

Constructor & Destructor Documentation

MPresenceCacheWriter()

~MPresenceCacheWriter()

Member Functions Documentation

CancelWrite()

DeletePresenceL(const MXIMPIdentity &)

Parameters

DeleteService(const TDesC &)

Parameters

NewBuddyPresenceInfoLC()

NewIdentityLC()

NewL()

NewPresenceBuddyInfoListLC(const TDesC &)

Parameters

NewPresenceInfoLC()

PresenceObjectFactory()

WritePresenceL(const MPresenceBuddyInfo *)

Parameters

WritePresenceL(const MPresenceBuddyInfoList *, MPresCacheWriteHandler *)

Parameters

Member Data Documentation

TUid iEcomDtorID

WritePresenceL(const MPresenceBuddyInfoList , MPresCacheWriteHandler )