Collapse all Symbian^3 Application Developer Library

RSatRefresh Class Reference

class RSatRefresh : public RSubSessionBase

Sub-session for getting refresh notifies.

SatClient.lib

Since: Series 60 2.6

Inherits from

RSatRefresh
- RSubSessionBase

Public Member Functions
	RSatRefresh ( MSatRefreshObserver &)
void	AllowRefreshL ( TBool )
IMPORT_C void	Cancel ()
void	CancelNotifyAllowRefresh ( TInt )
void	CancelNotifyRefresh ()
IMPORT_C void	Close ()
void	NotifyAllowRefresh ( TPckg < TSatRefreshType > &, TPckg < TSatRefreshFiles > &, TRequestStatus &)
IMPORT_C void	NotifyFileChangeL ()
IMPORT_C void	NotifyFileChangeL (const TSatRefreshFiles &)
void	NotifyRefresh ( TPckg < TSatRefreshType > &, TPckg < TSatRefreshFiles > &, TRequestStatus &)
IMPORT_C void	OpenL (const RSatSession &)
IMPORT_C void	RefreshEFRead ( 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_C

RSatRefresh

(

MSatRefreshObserver &

aObserver

)

C++ default constructor.

Parameters

MSatRefreshObserver & aObserver

Observer, which is notified about refresh.

RSatRefresh(const RSatRefresh &)

RSatRefresh

(

const RSatRefresh &

)

[private]

Parameters

const RSatRefresh &

Member Functions Documentation

AllowRefreshL(TBool)

void

AllowRefreshL

(

TBool

aAllow

)

const

Sends response for refresh quary.

Parameters

TBool aAllow

ETrue, refresh is allowed, EFalse refresh not allowed.

Cancel()

IMPORT_C void

Cancel

(

)

const

Cancels the notification.

CancelNotifyAllowRefresh(TInt)

void

CancelNotifyAllowRefresh

(

TInt

aError = KErrNone

)

const

Cancels the notification.

Parameters

TInt aError = KErrNone

CancelNotifyRefresh()

void

CancelNotifyRefresh

(

)

const

Cancels the notification.

Close()

IMPORT_C void

(

)

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

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

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

Gets the notification of refresh query.

Parameters

TPckg < TSatRefreshType > & aType	Refresh type.
TPckg < TSatRefreshFiles > & aChangingFiles	List of files to be changed if any.
TRequestStatus & aStatus	Request status.

NotifyFileChangeL()

IMPORT_C void

NotifyFileChangeL

(

)

Starts the waiting for refresh events.

NotifyFileChangeL(const TSatRefreshFiles &)

IMPORT_C void

NotifyFileChangeL

(

const TSatRefreshFiles &

aObservedFiles

)

Starts the waiting for refresh events.

Parameters

const TSatRefreshFiles & aObservedFiles

List of files to be observed for refresh.

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

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

Gets the notification of refresh.

Parameters

TPckg < TSatRefreshType > & aType	Refresh type.
TPckg < TSatRefreshFiles > & aFiles	List of changed files if any.
TRequestStatus & aStatus	Request status.

OpenL(const RSatSession &)

IMPORT_C void

OpenL

(

const RSatSession &

aSession

)

Opens the sub-session.

Parameters

const RSatSession & aSession

Opens the sub-session.

RefreshEFRead(TBool)

IMPORT_C void

RefreshEFRead

(

TBool

aAdditionEFRead

)

const

Indicates client's refresh actions complete.

Parameters

TBool aAdditionEFRead

Client 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]