Collapse all Symbian^3 Application Developer Library

MLbtTriggerStore Class Reference

class MLbtTriggerStore

This M class defines the interface for the trigger stores.

The Trigger Store Managers must implement this interface to provide the store functionality.

Nested Classes and Structures

MLbtTriggerStore::TLbtTriggerModifiedInfo

Public Member Functions
	~MLbtTriggerStore ()
TInt	CancelCurrentOperation ()
void	CreateTriggerL ( CLbtContainerTriggerEntry &, TRequestStatus &)
void	DeleteTriggerL ( TLbtTriggerId )
void	DeleteTriggersL ( CLbtContainerUpdateFilter *, TLbtSecurityPolicy &, TRequestStatus &)
TInt	GetCountOfEnabledAndValidTriggers ()
void	GetTriggersL ( RArray < TLbtTriggerId > &, RPointerArray < CLbtContainerTriggerEntry > &, TLbtSecurityPolicy &, TRequestStatus &)
TBool	IsStoreBusy ()
void	ListTriggersL ( CLbtContainerListOptions *, RPointerArray < CLbtContainerTriggerEntry > &, TLbtSecurityPolicy &, TRequestStatus &)
void	SetStoreChangeObserver ( MLbtTriggerStoreObserver *)
void	SetTimeTillCompaction ( TTime )
TTriggerTypeMask	SupportedTriggerTypes ()
void	TriggersModified ( RArray < TLbtTriggerModifiedInfo > &)
void	UpdateTriggerFiredStateL ( RArray < TLbtTriggerId > &, TBool , TRequestStatus &)
void	UpdateTriggerL ( CLbtContainerTriggerEntry &, TLbtTriggerDataMask , TLbtTriggerAttributeFieldsMask , TLbtSecurityPolicy &, TRequestStatus &)
void	UpdateTriggersStateL ( CLbtTriggerEntry::TLbtTriggerState , CLbtContainerUpdateFilter *, TLbtFireOnUpdate , TLbtSecurityPolicy &, TRequestStatus &)
void	UpdateTriggersValidityL ( TLbtTriggerDynamicInfo::TLbtTriggerValidity , RArray < TLbtTriggerId > &, TLbtSecurityPolicy &, TRequestStatus &)

Constructor & Destructor Documentation

~MLbtTriggerStore()

~MLbtTriggerStore

(

)

[inline, virtual]

pure virtual destructor

Member Functions Documentation

CancelCurrentOperation()

TInt

CancelCurrentOperation

(

)

[pure virtual]

The implementation of this method should cancel any ongoing async operation

CreateTriggerL(CLbtContainerTriggerEntry &, TRequestStatus &)

void	CreateTriggerL	(	CLbtContainerTriggerEntry &	aEntry,
			TRequestStatus &	aStatus
		)	[pure virtual]

Creates a trigger in the trigger store in a asynchronous fashion. Once the creation is complete the client is signalled by completing its active object. The request staus of the active object will hold the error code which informs the client of the status of the creation.

Parameters

CLbtContainerTriggerEntry & aEntry	reference to the trigger entry object that contains the trigger data which has to be created.
TRequestStatus & aStatus	the clients request status

DeleteTriggerL(TLbtTriggerId)

void

DeleteTriggerL

(

TLbtTriggerId

aTriggerId

)

[pure virtual]

Deletes a single trigger which matches the trigger id supplied

Parameters

TLbtTriggerId aTriggerId

the id of the trigger which needs to be deleted

DeleteTriggersL(CLbtContainerUpdateFilter *, TLbtSecurityPolicy &, TRequestStatus &)

void	DeleteTriggersL	(	CLbtContainerUpdateFilter *	aFilter,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Deletes multiple triggers based container update filter. All the trigger in the store that satisfy the supplied filter are deleted from the store.

Parameters

CLbtContainerUpdateFilter * aFilter	the filter based on which the triggers are selected to be updated
TLbtSecurityPolicy & aSecurityPolicy
TRequestStatus & aStatus	the clients active status

GetCountOfEnabledAndValidTriggers()

TInt

GetCountOfEnabledAndValidTriggers

(

)

[pure virtual]

Returns the count of all the enabled and valid triggers in the store.

GetTriggersL(RArray< TLbtTriggerId > &, RPointerArray< CLbtContainerTriggerEntry > &, TLbtSecurityPolicy &, TRequestStatus &)

void	GetTriggersL	(	RArray < TLbtTriggerId > &	aTriggerIds,
			RPointerArray < CLbtContainerTriggerEntry > &	aTriggers,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Used to retreive a specified list of triggers from the store. This triggers are specifed using an array of trigger ids.

Parameters

RArray < TLbtTriggerId > & aTriggerIds	the array of trigger ids which need to be retreived
RPointerArray < CLbtContainerTriggerEntry > & aTriggers	reference to the pointer array into which the trigger are retreived from the trigger store
TLbtSecurityPolicy & aSecurityPolicy	the security policy that the triggers have to satisfy
TRequestStatus & aStatus	the clients active status

IsStoreBusy()

TBool

IsStoreBusy

(

)

[pure virtual]

Method to check if the trigger store is busy. The store could be busy due to many reasons with the mail reason being compaction.

ListTriggersL(CLbtContainerListOptions *, RPointerArray< CLbtContainerTriggerEntry > &, TLbtSecurityPolicy &, TRequestStatus &)

void	ListTriggersL	(	CLbtContainerListOptions *	aFilter,
			RPointerArray < CLbtContainerTriggerEntry > &	aTriggers,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Used to list trigger based on list options. The list options contains a filter based on which the trigger will be listed. The listing is done asynchronously

Parameters

CLbtContainerListOptions * aFilter	the container list options which contains the filter based on which trigger are filtered in the trigger store
RPointerArray < CLbtContainerTriggerEntry > & aTriggers	refernce to the pointer array into which the trigger are retreived from the trigger store and stored
TLbtSecurityPolicy & aSecurityPolicy
TRequestStatus & aStatus	the clients active status

SetStoreChangeObserver(MLbtTriggerStoreObserver *)

void

SetStoreChangeObserver

(

MLbtTriggerStoreObserver *

aObserver

)

[pure virtual]

Used to set the trigger store observer. The set observer will be notifed if any updation operation is preformed on the trigger store. The modification include creation, updation or deletion of any trigger

Parameters

MLbtTriggerStoreObserver * aObserver

SetTimeTillCompaction(TTime)

void

SetTimeTillCompaction

(

TTime

aTime

)

[pure virtual]

Used to set the time till when compaction is preferred. Over the time specified compaction should not happed in ideal cases. As and when compaction happens this time is check to see that compaction does not over shoot this time interval

Parameters

TTime aTime

the time untill which compaction can proceed without effecting the system

SupportedTriggerTypes()

TTriggerTypeMask

SupportedTriggerTypes

(

)

[pure virtual]

This method returns the types of triggers that are supported in this trigger store.

TriggersModified(RArray< TLbtTriggerModifiedInfo > &)

void

TriggersModified

(

RArray < TLbtTriggerModifiedInfo > &

aArray

)

[pure virtual]

Function should append the information of the trigger that has been modfied by the latest operation

Parameters

RArray < TLbtTriggerModifiedInfo > & aArray

the array of the client to which the trigger info should be appended

UpdateTriggerFiredStateL(RArray< TLbtTriggerId > &, TBool, TRequestStatus &)

void	UpdateTriggerFiredStateL	(	RArray < TLbtTriggerId > &	aTriggerIds,
			TBool	aFireBool,
			TRequestStatus &	aStatus
		)	[pure virtual]

Updates the fired state of multiple triggers specified by the trigger ids

Parameters

RArray < TLbtTriggerId > & aTriggerIds	the array of trigger ids of which the validity have to be changed
TBool aFireBool	the state to which the fired attributes has to be changed to
TRequestStatus & aStatus	the clients active status

UpdateTriggerL(CLbtContainerTriggerEntry &, TLbtTriggerDataMask, TLbtTriggerAttributeFieldsMask, TLbtSecurityPolicy &, TRequestStatus &)

void	UpdateTriggerL	(	CLbtContainerTriggerEntry &	aEntry,
			TLbtTriggerDataMask	aDataMask,
			TLbtTriggerAttributeFieldsMask	aAttrMask,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Updates the contents of a trigger in the trigger store based on masks. The trigger is searched in the trigger store based on the trigger id supplied in the trigger entry object. The masks define the trigger data members that need to be updated. This request is processed asychronously.

Parameters

CLbtContainerTriggerEntry & aEntry	reference to the trigger entry object that contains the trigger data which has to be created.
TLbtTriggerDataMask aDataMask	the data mask based on which the contents in the triggers dynamic info is updated. The masks are defined by enumeration TLbtTriggerDynamicInfo::TLbtDynamicInfoAttribute
TLbtTriggerAttributeFieldsMask aAttrMask	the attribute mask based on which the atrributes of the trigger are updated. The masks are defined by enumeration CLbtTriggerEntry::TAttribute
TLbtSecurityPolicy & aSecurityPolicy
TRequestStatus & aStatus	the clients active status

UpdateTriggersStateL(CLbtTriggerEntry::TLbtTriggerState, CLbtContainerUpdateFilter *, TLbtFireOnUpdate, TLbtSecurityPolicy &, TRequestStatus &)

void	UpdateTriggersStateL	(	CLbtTriggerEntry::TLbtTriggerState	aState,
			CLbtContainerUpdateFilter *	aFilter,
			TLbtFireOnUpdate	aFireOnUpdate,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Updates the state of multiple triggers based on container filter. This request is processed asychronously.

Parameters

CLbtTriggerEntry::TLbtTriggerState aState	the state to which the triggers that fall in the filter needs to be to updated to
CLbtContainerUpdateFilter * aFilter	the filter based on which the triggers are selected to be updated
TLbtFireOnUpdate aFireOnUpdate
TLbtSecurityPolicy & aSecurityPolicy
TRequestStatus & aStatus	the clients active status

UpdateTriggersValidityL(TLbtTriggerDynamicInfo::TLbtTriggerValidity, RArray< TLbtTriggerId > &, TLbtSecurityPolicy &, TRequestStatus &)

void	UpdateTriggersValidityL	(	TLbtTriggerDynamicInfo::TLbtTriggerValidity	aValidity,
			RArray < TLbtTriggerId > &	aTriggerIds,
			TLbtSecurityPolicy &	aSecurityPolicy,
			TRequestStatus &	aStatus
		)	[pure virtual]

Updates the validity of multiple triggers specified by trigger ids.

Parameters

TLbtTriggerDynamicInfo::TLbtTriggerValidity aValidity	the validity to which the triggers have to be changed to
RArray < TLbtTriggerId > & aTriggerIds	the array of trigger ids of which the validity have to be changed
TLbtSecurityPolicy & aSecurityPolicy
TRequestStatus & aStatus	the clients active status