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

Constructor & Destructor Documentation

~CFscContactActionService()

~CFscContactActionService()[inline, virtual]

Destructor.

Member Functions Documentation

AllActionsListL(TUint64)

const CFscContactActionList &AllActionsListL(TUint64aActionTypeFlags)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 aActionTypeFlagsAction type flags which are used to filter actions. Use value KFscAtAll to get all.

CancelExecute()

voidCancelExecute()[pure virtual]

Cancels async method ExecuteL.

CancelQueryActions()

voidCancelQueryActions()[pure virtual]

Cancels async method QueryActionsL.

ExecuteL(TUid, MFscContactActionServiceObserver *)

voidExecuteL(TUidaActionUid,
MFscContactActionServiceObserver *aObserver
)[pure virtual]

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

Parameters

TUid aActionUiduid 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)

voidQueryActionsL(MFscContactActionServiceObserver *aObserver,
TBoolaStopWhenOneActionFound = EFalse,
TUint64aActionTypeFlags =  KFscAtDefault ,
TIntaMinPriority = 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 = EFalsestops query when at least one action found.
TUint64 aActionTypeFlags =  KFscAtDefault Action type flags which are used to filter actions.
TInt aMinPriority = 0Minimum 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 *)

voidSetContactSetL(MFscContactLinkIterator *aIterator)[pure virtual]

Method for setting current contact set to the service.

Parameters

MFscContactLinkIterator * aIteratoriterator to collection of MVPbkContactLink objects. Collection can contain links to contacts and group.

SetContactSetL(const RFscStoreContactList &)

voidSetContactSetL(const RFscStoreContactList &aStoreContactList)[pure virtual]

Method for setting current contact set to the service.

Parameters

const RFscStoreContactList & aStoreContactListcollection 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.