Collapse all Symbian^3 Application Developer Library

CTriggerParams Class Reference

class CTriggerParams : public CBase

This class is used to retrieve the active trigger session information. The required memory for the parameters will be allocated during construction of this class and this class owns the memory allocated. And same will be released when this class is destroyed. The trigger session information includes

Notification Present (Yes/No)
TriggerNotificationStaus (On/Off)
TriggerType (Periodic/Area Event)
TriggerParams for Periodic triggering --- OutstandingTriggers (Interger) --- Interval (Integer)

From the abover properties, only following fieds can be changed by SUPL settings client:

TriggerNotificationStaus (On/Off)

Inherits from

CTriggerParams
- CBase

Public Member Functions
	~CTriggerParams ()
IMPORT_C TInt	Get ( TInt64 &, TPtr , TBool &, TBool &, TTriggerType &, TRequestType &, TUint64 &, TUint64 &)
IMPORT_C CTriggerParams *	NewL ()
IMPORT_C CTriggerParams *	NewLC ()
IMPORT_C TInt	Set ( TInt64 , const TDesC &, TBool , TBool , TTriggerType , TRequestType , TUint64 , TUint64 )

Private Member Functions
	CTriggerParams ()
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()

Public Member Enumerations
enum	TRequestType { EUnSpecified = -1, ENetworkInitiated = 0, ETerminalInitiated }
enum	TTriggerType { EUnknown = -1, EPeriodic = 0, EAreaEvent }

Private Attributes
TUint64	iInterval
TBool	iIsValueSet
TBool	iNotificationPresent
TUint64	iOutstandingTrigger
TRequestType	iRequestType
TInt64	iSessionId
HBufC *	iSessionName
TBool	iTriggerNotificationStatus
TTriggerType	iTriggerType

Constructor & Destructor Documentation

CTriggerParams()

CTriggerParams

(

)

[private]

C++ default constructor.

Since: S60 5.2

~CTriggerParams()

IMPORT_C

~CTriggerParams

(

)

Destructor.

Since: S60 5.2

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

By default EPOC constructor is private.

Since: S60 5.2

Get(TInt64 &, TPtr, TBool &, TBool &, TTriggerType &, TRequestType &, TUint64 &, TUint64 &)

IMPORT_C TInt	Get	(	TInt64 &	aSessionId,
			TPtr	aSessionName,
			TBool &	aNotificationPresent,
			TBool &	aTriggerNotificationStatus,
			TTriggerType &	aTriggerType,
			TRequestType &	aRequestType,
			TUint64 &	aOutstandingTrigger,
			TUint64 &	aInterval
		)	const

Returns trigger parameters.

Since: S60 5.2

Parameters

TInt64 & aSessionId
TPtr aSessionName
TBool & aNotificationPresent
TBool & aTriggerNotificationStatus
TTriggerType & aTriggerType
TRequestType & aRequestType
TUint64 & aOutstandingTrigger
TUint64 & aInterval

NewL()

IMPORT_C CTriggerParams *

NewL

(

)

[static]

Two-phased constructor.

Since: S60 5.2

NewLC()

IMPORT_C CTriggerParams *

NewLC

(

)

[static]

Two-phased constructor.

Since: S60 5.2

Set(TInt64, const TDesC &, TBool, TBool, TTriggerType, TRequestType, TUint64, TUint64)

IMPORT_C TInt	Set	(	TInt64	aSessionId,
			const TDesC &	aSessionName,
			TBool	aNotificationPresent,
			TBool	aTriggerNotificationStatus,
			TTriggerType	aTriggerType,
			TRequestType	aRequestType,
			TUint64	aOutstandingTrigger,
			TUint64	aInterval
		)

Sets trigger parameters.

Since: S60 5.2

Parameters

TInt64 aSessionId
const TDesC & aSessionName
TBool aNotificationPresent
TBool aTriggerNotificationStatus
TTriggerType aTriggerType
TRequestType aRequestType
TUint64 aOutstandingTrigger
TUint64 aInterval