Collapse all Symbian^3 Application Developer Library

CFscContactActionService Class Reference

class CFscContactActionService : public CBase

Contact Action Service API. Defines an ECom interface for the Contact Action Service.

Since: S60 3.1

Inherits from

CFscContactActionService
- CBase

Public Member Functions
	~CFscContactActionService ()
const CFscContactActionList &	AllActionsListL ( TUint64 )
void	CancelExecute ()
void	CancelQueryActions ()
void	ExecuteL ( TUid , MFscContactActionServiceObserver *)
CFscContactActionService *	NewL ( CVPbkContactManager &)
void	QueryActionsL ( MFscContactActionServiceObserver *, TBool , TUint64 , TInt )
const CFscContactActionList &	QueryResults ()
void	SetContactSetL (MFscContactLinkIterator *)
void	SetContactSetL (const RFscStoreContactList &)

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
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CFscContactActionService()

~CFscContactActionService

(

)

[inline, virtual]

Destructor.

Member Functions Documentation

AllActionsListL(TUint64)

const CFscContactActionList &

AllActionsListL

(

TUint64

aActionTypeFlags

)

const [pure virtual]

Method for quering all actions from existing action plugins. Unlike QueryActionsL, this doesn't consider contact data but just returns all actions.

Parameters

TUint64 aActionTypeFlags

Action type flags which are used to filter actions. Use value KFscAtAll to get all.

CancelExecute()

void

CancelExecute

(

)

[pure virtual]

Cancels async method ExecuteL.

CancelQueryActions()

void

CancelQueryActions

(

)

[pure virtual]

Cancels async method QueryActionsL.

ExecuteL(TUid, MFscContactActionServiceObserver *)

void	ExecuteL	(	TUid	aActionUid,
			MFscContactActionServiceObserver *	aObserver
		)	[pure virtual]

Execute action. Asynchronous. Data is ready when observer's ExecuteComplete mthod is invoked.

Parameters

TUid aActionUid	uid of action to be executed
MFscContactActionServiceObserver * aObserver

NewL(CVPbkContactManager &)

CFscContactActionService *

NewL

(

CVPbkContactManager &

aContactManager

)

[static, inline]

Two-phased constructor.

Parameters

CVPbkContactManager & aContactManager

QueryActionsL(MFscContactActionServiceObserver *, TBool, TUint64, TInt)

void	QueryActionsL	(	MFscContactActionServiceObserver *	aObserver,
			TBool	aStopWhenOneActionFound = EFalse,
			TUint64	aActionTypeFlags = KFscAtDefault ,
			TInt	aMinPriority = 0
		)	[pure virtual]

Method for quering available actions Method searches actions for pre-set contact/group set. Results can be received with QueryResults method. Asynchronous. Data is ready when observer's QueryActionsComplete method is invoked.

Parameters

MFscContactActionServiceObserver * aObserver
TBool aStopWhenOneActionFound = EFalse	stops query when at least one action found.
TUint64 aActionTypeFlags = KFscAtDefault	Action type flags which are used to filter actions.
TInt aMinPriority = 0	Minimum allowed priority for returned actions.

QueryResults()

const CFscContactActionList &

QueryResults

(

)

const [pure virtual]

Return action query results. Empty list is returned if no queries has been done

SetContactSetL(MFscContactLinkIterator *)

void

SetContactSetL

(

MFscContactLinkIterator *

aIterator

)

[pure virtual]

Method for setting current contact set to the service.

Parameters

MFscContactLinkIterator * aIterator

iterator to collection of MVPbkContactLink objects. Collection can contain links to contacts and group.

SetContactSetL(const RFscStoreContactList &)

void

SetContactSetL

(

const RFscStoreContactList &

aStoreContactList

)

[pure virtual]

Method for setting current contact set to the service.

Parameters

const RFscStoreContactList & aStoreContactList

collection of MVPbkStoreContact objects. Collection can contain ONLY contacts (no groups).

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

iDtor_ID_Key Instance identifier key. When instance of an implementation is created by ECOM framework, the framework will assign UID for it. The UID is used in destructor to notify framework that this instance is being destroyed and resources can be released.