Collapse all Symbian^3 Product Developer Library

CEvtEventManager Class Reference

class CEvtEventManager : public CBase

Interface class to store and access the Location Events. This class allows for Events to be stored in persistent database. Events can be added, deleted and modified from database. This class also allows for monitoring any changes to the database. This is achieved by setting observer to the database.

evtstorage.lib

Since: S60 v9.1

Inherits from

CEvtEventManager
- CBase

Public Member Functions
	~CEvtEventManager()
IMPORT_C void	AddEventL(CEvtEvent &)
IMPORT_C CEvtEvent *	GetEventL(TEvtEventId)
IMPORT_C void	GetEventsL(TEvtEventStatus, RPointerArray< CEvtBasicEventInfo > &)
IMPORT_C void	GetEventsL(RPointerArray< CEvtBasicEventInfo > &)
IMPORT_C CEvtEventManager *	NewL()
IMPORT_C CEvtEventManager *	NewLC()
IMPORT_C void	RemoveEventL(TEvtEventId)
IMPORT_C void	RemoveEventsL(const RArray< TEvtEventId > &)
IMPORT_C void	SetObserver(MEvtStorageDbObserver *)
IMPORT_C void	UpdateEventL(CEvtEvent &)
IMPORT_C void	UpdateEventStatusL(TEvtEventId, TEvtEventStatus)
IMPORT_C void	UpdateEventsStatusL(const RArray< TEvtEventId > &, TEvtEventStatus)

Private Member Functions
	CEvtEventManager()
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CEvtDatabase *	iEvtDb

Constructor & Destructor Documentation

CEvtEventManager()

CEvtEventManager

(

)

[private]

Default C++ Constructor.

~CEvtEventManager()

~CEvtEventManager

(

)

[virtual]

Destructor.

Member Functions Documentation

AddEventL(CEvtEvent &)

IMPORT_C void

AddEventL

(

CEvtEvent &

aEvtEvent

)

Inserts a new Event to Database.

The application will pass the Event that has to be inserted in the database.

Since: S60 v9.1

Parameters

CEvtEvent & aEvtEvent

ConstructL()

void

ConstructL

(

)

[private]

Second phase of the two phase constructor.

GetEventL(TEvtEventId)

IMPORT_C CEvtEvent *

GetEventL

(

TEvtEventId

aEvtId

)

Gets an Event based on Event Id passed.

The application can get the Event info based on the EventId passed.

The ownership of the returned Event is transferred to the caller.

Since: S60 v9.1

Parameters

TEvtEventId aEvtId

EventId that decides the Event to be returned.

GetEventsL(TEvtEventStatus, RPointerArray< CEvtBasicEventInfo > &)

IMPORT_C void	GetEventsL	(	TEvtEventStatus	aEvtStatus,
			RPointerArray< CEvtBasicEventInfo > &	aEvtEventArray
		)

Gets a sorted list of Events based on Event Status Criteria. The sort is based on Event's Subject Field.

The application can decide upon the list of Events returned. This can be achieved by passing a Event Status as the parameter to this function. The status of the Events is defined by TEvtEventStatus

The ownership of the list of Events is transferred to the caller.

Since: S60 v9.1

Parameters

TEvtEventStatus aEvtStatus
RPointerArray< CEvtBasicEventInfo > & aEvtEventArray

GetEventsL(RPointerArray< CEvtBasicEventInfo > &)

IMPORT_C void

GetEventsL

(

RPointerArray< CEvtBasicEventInfo > &

aEvtEventArray

)

Gets a sorted list of ALL Events. The sort is based on Event's Subject Field.

The application gets all the Events entry from the database.

The ownership of the list of Events is transferred to the caller.

Since: S60 v9.1

Parameters

RPointerArray< CEvtBasicEventInfo > & aEvtEventArray

NewL()

IMPORT_C CEvtEventManager *

NewL

(

)

[static]

Constructs a new instance of Event Storage Manager interface.

leave: System wide error code if the object creation fails.

NewLC()

IMPORT_C CEvtEventManager *

NewLC

(

)

[static]

Constructs a new instance of Event Storage Manager interface. Leaves the created instance on the cleanup stack.

leave: System wide error code if the object creation fails.

RemoveEventL(TEvtEventId)

IMPORT_C void

RemoveEventL

(

TEvtEventId

aEvtId

)

Delete an Event from Database.

The application will pass the Event that has to be deleted from the database.

Since: S60 v9.1

Parameters

TEvtEventId aEvtId

RemoveEventsL(const RArray< TEvtEventId > &)

IMPORT_C void

RemoveEventsL

(

const RArray< TEvtEventId > &

aEvtIdArray

)

Deletes the List of Events from Database.

The application delete the list of Events from the database.

Since: S60 v9.1

Parameters

const RArray< TEvtEventId > & aEvtIdArray

SetObserver(MEvtStorageDbObserver *)

IMPORT_C void

SetObserver

(

MEvtStorageDbObserver *

aDbObserver

)

Set the Observer for the Storage Database.

The application can listen to the change in the Storage database by setting the Observer.

Since: S60 v9.1

Parameters

MEvtStorageDbObserver * aDbObserver

An Observer to listen to Storage database changes.

UpdateEventL(CEvtEvent &)

IMPORT_C void

UpdateEventL

(

CEvtEvent &

aEvtEvent

)

Updates the given Event to Database.

The application will pass the Event that has to be updated in the database.

Since: S60 v9.1

Parameters

CEvtEvent & aEvtEvent

Reference to the Event that is to be updated in the database.

UpdateEventStatusL(TEvtEventId, TEvtEventStatus)

IMPORT_C void	UpdateEventStatusL	(	TEvtEventId	aEvtId,
			TEvtEventStatus	aEvtStatus
		)

Update the status of an Event in Database.

The application will pass the Event whose status is updated in the database.

Since: S60 v9.1

Parameters

TEvtEventId aEvtId
TEvtEventStatus aEvtStatus

UpdateEventsStatusL(const RArray< TEvtEventId > &, TEvtEventStatus)

IMPORT_C void	UpdateEventsStatusL	(	const RArray< TEvtEventId > &	aEvtIdArray,
			TEvtEventStatus	aEvtStatus
		)

Update the status of events in Database.

The application will pass the list of Events whose status are updated in the database.

Since: S60 v9.1

Parameters

const RArray< TEvtEventId > & aEvtIdArray
TEvtEventStatus aEvtStatus

Member Data Documentation

CEvtDatabase * iEvtDb

CEvtDatabase *

iEvtDb

[private]

CEvtDatabaseRequest Instance