CLbtSessionTrigger Class Reference

class CLbtSessionTrigger : public CLbtTriggerEntry

Concrete class representing session trigger entries.

Session triggers are not stored in persistent storage. They are deleted by Location Triggering Server if the client application's subsession to the server is closed or if the client calls RLbt::DeleteTriggerL().

Client application shall make request to Location Triggering Server to receive session trigger firing event.

RLbtlbt.lib

Since
S60 5.1

Inherits from

Public Member Functions
~CLbtSessionTrigger()
IMPORT_C CLbtSessionTrigger *NewL()
IMPORT_C CLbtSessionTrigger *NewL(const TDesC &, TLbtTriggerState, CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &, TUid, CLbtTriggerConditionBase *)
IMPORT_C CLbtSessionTrigger *NewL(const TDesC &, TLbtTriggerState, const RRequestorStack &, TUid, CLbtTriggerConditionBase *)
IMPORT_C CLbtSessionTrigger *NewLC()
IMPORT_C TTypeType()
Protected Member Functions
voidDoExternalizeL(RWriteStream &)
voidDoInternalizeL(RReadStream &)
Private Member Functions
CLbtSessionTrigger()
CLbtSessionTrigger(CLbtSessionTrigger &)
voidConstructL(const TDesC &, TLbtTriggerState, CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &, TUid, CLbtTriggerConditionBase *)
voidConstructL(const TDesC &, CLbtTriggerEntry::TLbtTriggerState, const RRequestorStack &, TUid, CLbtTriggerConditionBase *)
voidConstructL()
CLbtSessionTrigger &operator=(const CLbtSessionTrigger &)
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()
CLbtTriggerEntry::CLbtTriggerEntry()
CLbtTriggerEntry::ExternalizeL(RWriteStream &)const
CLbtTriggerEntry::GetCondition()
CLbtTriggerEntry::GetCondition()const
CLbtTriggerEntry::GetRequestorsL(RRequestorStack &)const
CLbtTriggerEntry::Id()const
CLbtTriggerEntry::InternalizeL(RReadStream &)
CLbtTriggerEntry::ManagerUi()const
CLbtTriggerEntry::Name()const
CLbtTriggerEntry::SetCondition(CLbtTriggerConditionBase *)
CLbtTriggerEntry::SetId(TLbtTriggerId)
CLbtTriggerEntry::SetManagerUi(TUid)
CLbtTriggerEntry::SetNameL(const TDesC &)
CLbtTriggerEntry::SetRequestorL(CRequestor::TRequestorType,CRequestor::TRequestorFormat,const TDesC &)
CLbtTriggerEntry::SetRequestorsL(const RRequestorStack &)
CLbtTriggerEntry::SetState(TLbtTriggerState)
CLbtTriggerEntry::SetTimeToRearm(TInt)
CLbtTriggerEntry::State()const
CLbtTriggerEntry::TimeToRearm()const
CLbtTriggerEntry::~CLbtTriggerEntry()
Inherited Enumerations
CLbtTriggerEntry:TAttribute
CLbtTriggerEntry:TLbtTriggerState
CLbtTriggerEntry:TType

Constructor & Destructor Documentation

CLbtSessionTrigger()

CLbtSessionTrigger()[private]

Default constructor

CLbtSessionTrigger(CLbtSessionTrigger &)

CLbtSessionTrigger(CLbtSessionTrigger &aEntry)[private]

By default, prohibit copy constructor

Parameters

CLbtSessionTrigger & aEntry

~CLbtSessionTrigger()

IMPORT_C~CLbtSessionTrigger()

Destructor

Member Functions Documentation

ConstructL(const TDesC &, TLbtTriggerState, CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &, TUid, CLbtTriggerConditionBase *)

voidConstructL(const TDesC &aName,
TLbtTriggerStateaState,
CRequestor::TRequestorTypeaRequestorType,
CRequestor::TRequestorFormataRequestorFormat,
const TDesC &aRequestorData,
TUidaManagerUi,
CLbtTriggerConditionBase *aCondition
)[private]

Symbian 2nd phase constructor.

Parameters

const TDesC & aNameThe name of the trigger entry.
TLbtTriggerState aStateThe state of trigger entry.
CRequestor::TRequestorType aRequestorTypeIdentifies the type of requestor, a service or a contact.
CRequestor::TRequestorFormat aRequestorFormatDetermines the type of data held in aRequestorData
const TDesC & aRequestorDataRequestor data. Can be a telephone number, a URL etc.
TUid aManagerUiThe UID of the manager UI application.
CLbtTriggerConditionBase * aConditionPointer to the new trigger condition object.

ConstructL(const TDesC &, CLbtTriggerEntry::TLbtTriggerState, const RRequestorStack &, TUid, CLbtTriggerConditionBase *)

voidConstructL(const TDesC &aName,
CLbtTriggerEntry::TLbtTriggerStateaState,
const RRequestorStack &aRequestors,
TUidaManagerUi,
CLbtTriggerConditionBase *aCondition
)[private]

Symbian 2nd phase constructor.

Parameters

const TDesC & aNameThe name of the trigger entry.
CLbtTriggerEntry::TLbtTriggerState aStateThe state of trigger entry.
const RRequestorStack & aRequestors
TUid aManagerUiThe UID of manager UI application.
CLbtTriggerConditionBase * aConditionPointer to the new trigger condition object.

ConstructL()

voidConstructL()[private]

Symbian 2nd phase constructor.

DoExternalizeL(RWriteStream &)

voidDoExternalizeL(RWriteStream &aStream)const [protected, virtual]

Externalize method that subclass must implement.

Parameters

RWriteStream & aStreamStream to which the object should be externalized.

DoInternalizeL(RReadStream &)

voidDoInternalizeL(RReadStream &aStream)[protected, virtual]

Internalize method that subclass must implement.

Parameters

RReadStream & aStreamStream from which the object should be internalized.

NewL()

IMPORT_C CLbtSessionTrigger *NewL()[static]

Allocates and constructs a new session trigger entry.

In returned object, default values are set to the attributes of the trigger. The default values are
  • Trigger Id is KLbtNullTriggerId.

  • Trigger Name is an empty string.

  • Requestors are not set.

  • Manager UI is not set(KNullUid).

  • Trigger condition is not set.

NewL(const TDesC &, TLbtTriggerState, CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &, TUid, CLbtTriggerConditionBase *)

IMPORT_C CLbtSessionTrigger *NewL(const TDesC &aName,
TLbtTriggerStateaState,
CRequestor::TRequestorTypeaRequestorType,
CRequestor::TRequestorFormataRequestorFormat,
const TDesC &aRequestorData,
TUidaManagerUi,
CLbtTriggerConditionBase *aCondition
)[static]

Allocates and constructs a new session trigger entry with specified attribute values.

Since
S60 5.1
leave
KErrArgument If the name of the trigger is longer than KLbtMaxNameLength.
leave
Other standard symbian error code, such as KErrNoMemory, KErrGeneral, etc.

Parameters

const TDesC & aNameThe name of the trigger entry.
TLbtTriggerState aStateThe state of trigger entry.
CRequestor::TRequestorType aRequestorTypeIdentifies the type of requestor, a service or a contact.
CRequestor::TRequestorFormat aRequestorFormatDetermines the type of data held in aRequestorData
const TDesC & aRequestorDataRequestor data. Can be a telephone number, a URL etc.
TUid aManagerUiThe UID of the manager UI application.
CLbtTriggerConditionBase * aConditionPointer to the new trigger condition object. This object takes the ownership of aCondition.

NewL(const TDesC &, TLbtTriggerState, const RRequestorStack &, TUid, CLbtTriggerConditionBase *)

IMPORT_C CLbtSessionTrigger *NewL(const TDesC &aName,
TLbtTriggerStateaState,
const RRequestorStack &aRequestors,
TUidaManagerUi,
CLbtTriggerConditionBase *aCondition
)[static]

Allocates and constructs a new session trigger entry with specified attribute values.

leave
KErrArgument If the name of the trigger is longer than KLbtMaxNameLength.
leave
Other standard symbian error code, such as KErrNoMemory, KErrGeneral, etc.

Parameters

const TDesC & aNameThe name of the trigger entry.
TLbtTriggerState aStateThe state of trigger entry.
const RRequestorStack & aRequestorsThe requestor for the service. This object does not take ownership of aRequestors.
TUid aManagerUiThe UID of manager UI application.
CLbtTriggerConditionBase * aConditionPointer to the new trigger condition object. This object takes the ownership of aCondition.

NewLC()

IMPORT_C CLbtSessionTrigger *NewLC()[static]

Allocates and constructs a new session trigger entry. The constructed object is pushed onto cleanup stack.

In returned object, default values are set to the attributes of the trigger. The default values are
  • Trigger Id is KLbtNullTriggerId.

  • Trigger Name is an empty string.

  • Requestors are not set.

  • Manager UI is not set(KNullUid).

  • Trigger condition is not set.

Type()

IMPORT_C TTypeType()const [virtual]

Get the type of the trigger entry, CLbtTriggerEntry::ESession.

operator=(const CLbtSessionTrigger &)

CLbtSessionTrigger &operator=(const CLbtSessionTrigger &)[private]

Prohibit assigment operator

Parameters

const CLbtSessionTrigger &