Collapse all Symbian^3 Application Developer Library

CCFContextSubscription Class Reference

class CCFContextSubscription : public CBase

Subscription to get information of context changes.

cfservices.lib

Since: S60 5.0

Inherits from

CCFContextSubscription
- CBase

Public Member Functions
const TDesC &	ContextSource ()
const TDesC &	ContextType ()
TBool	DataObjectEnabled ()
IMPORT_C CCFContextSubscription *	NewL ()
IMPORT_C CCFContextSubscription *	NewLC ()
TBool	OnlyChangesIndicated ()
void	SetContextSourceL (const TDesC &)
void	SetContextTypeL (const TDesC &)
void	SetDataObjectEnabled ( TBool )
void	SetOnlyChangesIndicated ( TBool )
void	SetSubTypeMatch ( TBool )
TBool	SubTypeMatch ()

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()

Member Functions Documentation

ContextSource()

const TDesC &

ContextSource

(

)

const [pure virtual]

Returns a reference to the context source descriptor.

Since: S60 5.0

ContextType()

const TDesC &

ContextType

(

)

const [pure virtual]

Returns a reference to the context type descriptor.

Since: S60 5.0

DataObjectEnabled()

TBool

DataObjectEnabled

(

)

const [pure virtual]

Returns if this subscription also subscribes possible data object associated with the context.

Since: S60 5.0

NewL()

IMPORT_C CCFContextSubscription *

NewL

(

)

[static]

NewLC()

IMPORT_C CCFContextSubscription *

NewLC

(

)

[static]

OnlyChangesIndicated()

TBool

OnlyChangesIndicated

(

)

const [pure virtual]

Returns whether only context value changes are indicated.

Since: S60 5.0

SetContextSourceL(const TDesC &)

void

SetContextSourceL

(

const TDesC &

aSource

)

[pure virtual]

Sets desired context source. Copies the entire argument to the context source member variable.

Since: S60 5.0

Parameters

const TDesC & aSource

Desired context source or empty string if source doesn't matter.

SetContextTypeL(const TDesC &)

void

SetContextTypeL

(

const TDesC &

aContextType

)

[pure virtual]

Sets desired context type. Copies the entire argument to the context type member variable.

Since: S60 5.0

Parameters

const TDesC & aContextType

A complete or partial context type from the ontology. If the context type is partial all the context changes starting with this type are indicated. Example: Environment.Temperature Example2: Environment.

SetDataObjectEnabled(TBool)

void

SetDataObjectEnabled

(

TBool

aEnabled

)

[pure virtual]

Set indication to contain also possible data object if any. By default data objects are not subscribed.

Since: S60 5.0

Parameters

TBool aEnabled

Enable data objects. None.

SetOnlyChangesIndicated(TBool)

void

SetOnlyChangesIndicated

(

TBool

aIndicateChangesOnly

)

[pure virtual]

Set indication to happen only when context value changes. The default value for a new CCFContextSubscription is EFalse.

Since: S60 5.0

Parameters

TBool aIndicateChangesOnly

EFalse = all context publications are indicated, ETrue = only publications where context value changes form the previous value are indicated.

SetSubTypeMatch(TBool)

void

SetSubTypeMatch

(

TBool

aMatchSubTypes

)

[pure virtual]

Set whether subtypes of the context type are indicated. The default value for a new CCFContextSubscription is EFalse.

Since: S60 5.0

Parameters

TBool aMatchSubTypes

ETrue = subtypes are indicated by this subscription, EFalse = only type defined in this subscription is indicated.

SubTypeMatch()

TBool

SubTypeMatch

(

)

const [pure virtual]

Returns whether subtypes of the context type are indicated.

Since: S60 5.0