CHsCcApiClient Class Reference

class CHsCcApiClient : public CActive

Home screen content control server content control api client

       
hsccapiclient.lib
Since
S60 v5.0

Inherits from

Public Member Functions
~CHsCcApiClient ()
TInt ActivateAppL ( CHsContentInfo &)
TInt ActivateViewL ( CHsContentInfo &)
TInt ActiveAppL ( CHsContentInfo &)
TInt ActiveViewL ( CHsContentInfo &)
TInt AddViewL ( CHsContentInfo &)
TInt AddWidgetL ( CHsContentInfo &)
TInt AppListL ( CHsContentInfoArray &)
IMPORT_C CHsCcApiClient * NewL ( MHsContentControl *)
TInt RemoveViewL ( CHsContentInfo &)
TInt RemoveWidgetL ( CHsContentInfo &)
TInt ViewListL ( CHsContentInfoArray &)
TInt ViewListL ( CHsContentInfo &, CHsContentInfoArray &)
TInt WidgetListL ( CHsContentInfoArray &)
TInt WidgetListL ( CHsContentInfo &, CHsContentInfoArray &)
Private Member Functions
CHsCcApiClient ( MHsContentControl *)
void ConstructL ()
void DoCancel ()
TInt InternalizeContentInfoArrayL ( CHsContentInfoArray &, TUint32 , TUint32 )
TInt InternalizeContentInfoL ( CHsContentInfo &, TUint32 , TUint32 )
TInt InternalizeRespL ( TPtr8 &, TUint32 &, TUint32 &)
void RunL ()
void WaitForApiNtfL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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()
Inherited Enumerations
CActive:TPriority
Private Attributes
TUint32 iAddress
HBufC8 * iApiData
TPtr8 iApiDataPtr
HBufC8 * iApiHeader
TPtr8 iApiHeaderPtr
MHsContentControl * iObserver
TPckgBuf < TUint32 > iPckgReceiver
TPckgBuf < TUint32 > iPckgSender
RCcClientSession iSession
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CHsCcApiClient(MHsContentControl *)

CHsCcApiClient ( MHsContentControl * aControlIf ) [private]

Constructor

Parameters

MHsContentControl * aControlIf Content control observer interface

~CHsCcApiClient()

~CHsCcApiClient ( )

Destructor

Member Functions Documentation

ActivateAppL(CHsContentInfo &)

TInt ActivateAppL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

ActivateViewL(CHsContentInfo &)

TInt ActivateViewL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

ActiveAppL(CHsContentInfo &)

TInt ActiveAppL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

ActiveViewL(CHsContentInfo &)

TInt ActiveViewL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

AddViewL(CHsContentInfo &)

TInt AddViewL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

AddWidgetL(CHsContentInfo &)

TInt AddWidgetL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

AppListL(CHsContentInfoArray &)

TInt AppListL ( CHsContentInfoArray & aArray )

See from API documentation

Parameters

CHsContentInfoArray & aArray

ConstructL()

void ConstructL ( ) [private]

Second phase constructor

DoCancel()

void DoCancel ( ) [private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel() .

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel() .

CActive::Cancel

InternalizeContentInfoArrayL(CHsContentInfoArray &, TUint32, TUint32)

TInt InternalizeContentInfoArrayL ( CHsContentInfoArray & aInfo,
TUint32 aTrId,
TUint32 aDataSize
) [private]

Internalize received CHsContentInfoArray type response message data

Parameters

CHsContentInfoArray & aInfo
TUint32 aTrId
TUint32 aDataSize

InternalizeContentInfoL(CHsContentInfo &, TUint32, TUint32)

TInt InternalizeContentInfoL ( CHsContentInfo & aInfo,
TUint32 aTrId,
TUint32 aDataSize
) [private]

Internalize received CHsContentInfo type response message data

Parameters

CHsContentInfo & aInfo
TUint32 aTrId
TUint32 aDataSize

InternalizeRespL(TPtr8 &, TUint32 &, TUint32 &)

TInt InternalizeRespL ( TPtr8 & aResp,
TUint32 & aTrId,
TUint32 & aDataSize
) [private]

Internalize received response message

Parameters

TPtr8 & aResp
TUint32 & aTrId
TUint32 & aDataSize

NewL(MHsContentControl *)

IMPORT_C CHsCcApiClient * NewL ( MHsContentControl * aControlIf ) [static]

Two-phased constructor.

Parameters

MHsContentControl * aControlIf Content control observer interface

RemoveViewL(CHsContentInfo &)

TInt RemoveViewL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

RemoveWidgetL(CHsContentInfo &)

TInt RemoveWidgetL ( CHsContentInfo & aInfo )

See from API documentation

Parameters

CHsContentInfo & aInfo

RunL()

void RunL ( ) [private, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

ViewListL(CHsContentInfoArray &)

TInt ViewListL ( CHsContentInfoArray & aArray )

See from API documentation

Parameters

CHsContentInfoArray & aArray

ViewListL(CHsContentInfo &, CHsContentInfoArray &)

TInt ViewListL ( CHsContentInfo & aInfo,
CHsContentInfoArray & aArray
)

See from API documentation

Parameters

CHsContentInfo & aInfo
CHsContentInfoArray & aArray

WaitForApiNtfL()

void WaitForApiNtfL ( ) [private]

Requests receiving of content change notification

WidgetListL(CHsContentInfoArray &)

TInt WidgetListL ( CHsContentInfoArray & aArray )

See from API documentation

Parameters

CHsContentInfoArray & aArray

WidgetListL(CHsContentInfo &, CHsContentInfoArray &)

TInt WidgetListL ( CHsContentInfo & aInfo,
CHsContentInfoArray & aArray
)

See from API documentation

Parameters

CHsContentInfo & aInfo
CHsContentInfoArray & aArray

Member Data Documentation

TUint32 iAddress

TUint32 iAddress [private]

Registered address

HBufC8 * iApiData

HBufC8 * iApiData [private]

Received API request data buffer

TPtr8 iApiDataPtr

TPtr8 iApiDataPtr [private]

Pointer to data buffer

HBufC8 * iApiHeader

HBufC8 * iApiHeader [private]

Received API request header buffer

TPtr8 iApiHeaderPtr

TPtr8 iApiHeaderPtr [private]

Pointer to header buffer

MHsContentControl * iObserver

MHsContentControl * iObserver [private]

Home screen content control API observer

TPckgBuf< TUint32 > iPckgReceiver

TPckgBuf < TUint32 > iPckgReceiver [private]

receiver of Api request

TPckgBuf< TUint32 > iPckgSender

TPckgBuf < TUint32 > iPckgSender [private]

Sender of Api request

RCcClientSession iSession

RCcClientSession iSession [private]

Session to Homescreen content control server