Symbian^3 Product Developer Library >

RSatRefresh Class Reference

class RSatRefresh : public RSubSessionBase

Sub-session for getting refresh notifies.

SatClient.lib
Since
Series 60 2.6

Inherits from

Public Member Functions
RSatRefresh(MSatRefreshObserver &)
voidAllowRefreshL(TBool)
IMPORT_C voidCancel()
voidCancelNotifyAllowRefresh(TInt)
voidCancelNotifyRefresh()
IMPORT_C voidClose()
voidNotifyAllowRefresh(TPckg< TSatRefreshType > &, TPckg< TSatRefreshFiles > &, TRequestStatus &)
IMPORT_C voidNotifyFileChangeL()
IMPORT_C voidNotifyFileChangeL(const TSatRefreshFiles &)
voidNotifyRefresh(TPckg< TSatRefreshType > &, TPckg< TSatRefreshFiles > &, TRequestStatus &)
IMPORT_C voidOpenL(const RSatSession &)
IMPORT_C voidRefreshEFRead(TBool)
Private Member Functions
RSatRefresh(const RSatRefresh &)
RSatRefresh &operator=(const RSatRefresh &)
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Private Attributes
CSatAllowRefreshMonitor *iAllowMonitor
MSatRefreshObserver &iObserver
CSatRefreshMonitor *iRefreshMonitor

Constructor & Destructor Documentation

RSatRefresh(MSatRefreshObserver &)

IMPORT_CRSatRefresh(MSatRefreshObserver &aObserver)

C++ default constructor.

Parameters

MSatRefreshObserver & aObserverObserver, which is notified about refresh.

RSatRefresh(const RSatRefresh &)

RSatRefresh(const RSatRefresh &)[private]

Parameters

const RSatRefresh &

Member Functions Documentation

AllowRefreshL(TBool)

voidAllowRefreshL(TBoolaAllow)const

Sends response for refresh quary.

Parameters

TBool aAllowETrue, refresh is allowed, EFalse refresh not allowed.

Cancel()

IMPORT_C voidCancel()const

Cancels the notification.

CancelNotifyAllowRefresh(TInt)

voidCancelNotifyAllowRefresh(TIntaError =  KErrNone )const

Cancels the notification.

Parameters

TInt aError =  KErrNone

CancelNotifyRefresh()

voidCancelNotifyRefresh()const

Cancels the notification.

Close()

IMPORT_C voidClose()

Closes the sub-session. Cancels the notification if active.

NotifyAllowRefresh(TPckg< TSatRefreshType > &, TPckg< TSatRefreshFiles > &, TRequestStatus &)

voidNotifyAllowRefresh(TPckg< TSatRefreshType > &aType,
TPckg< TSatRefreshFiles > &aChangingFiles,
TRequestStatus &aStatus
)const

Gets the notification of refresh query.

Parameters

TPckg< TSatRefreshType > & aTypeRefresh type.
TPckg< TSatRefreshFiles > & aChangingFilesList of files to be changed if any.
TRequestStatus & aStatusRequest status.

NotifyFileChangeL()

IMPORT_C voidNotifyFileChangeL()

Starts the waiting for refresh events.

NotifyFileChangeL(const TSatRefreshFiles &)

IMPORT_C voidNotifyFileChangeL(const TSatRefreshFiles &aObservedFiles)

Starts the waiting for refresh events.

Parameters

const TSatRefreshFiles & aObservedFilesList of files to be observed for refresh.

NotifyRefresh(TPckg< TSatRefreshType > &, TPckg< TSatRefreshFiles > &, TRequestStatus &)

voidNotifyRefresh(TPckg< TSatRefreshType > &aType,
TPckg< TSatRefreshFiles > &aFiles,
TRequestStatus &aStatus
)const

Gets the notification of refresh.

Parameters

TPckg< TSatRefreshType > & aTypeRefresh type.
TPckg< TSatRefreshFiles > & aFilesList of changed files if any.
TRequestStatus & aStatusRequest status.

OpenL(const RSatSession &)

IMPORT_C voidOpenL(const RSatSession &aSession)

Opens the sub-session.

Parameters

const RSatSession & aSessionOpens the sub-session.

RefreshEFRead(TBool)

IMPORT_C voidRefreshEFRead(TBoolaAdditionEFRead)const

Indicates client's refresh actions complete.

Parameters

TBool aAdditionEFReadClient has read additional file(s) from those implicitly defined by refresh.

operator=(const RSatRefresh &)

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

Parameters

const RSatRefresh &

Member Data Documentation

CSatAllowRefreshMonitor * iAllowMonitor

CSatAllowRefreshMonitor *iAllowMonitor[private]

MSatRefreshObserver & iObserver

MSatRefreshObserver &iObserver[private]

CSatRefreshMonitor * iRefreshMonitor

CSatRefreshMonitor *iRefreshMonitor[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.