CDownloadMgrUiUserInteractions Class Reference

API published in: S60 2nd Ed FP 3

Link against: downloadmgruilib.lib

Capability Information

Required Capabilities

None

#include <cdownloadmgruiuserinteractions.h>

Inherits CDownloadMgrUiBase, and MHttpDownloadMgrObserver.

Detailed Description

The User Interactions supports the followings:

Public Types

enum  TDownloadMgrUiUserInteractionsAttr { EAttrSuppressDownloadConfirmation }
 Attribute enumerations. More...

Public Member Functions

virtual ~CDownloadMgrUiUserInteractions ()
 Destructor.
IMPORT_C TBool OkToExitL ()
 Client Apps can call this function before exiting the application.
IMPORT_C TInt PrepareToExit (CEikAppUi &aAppUi, TClientAppExitType aExitType, TVwsViewId aViewId, TUid aCustomMessageId, const TDesC8 &aViewActivationMsg)
 Client Apps can call this function in the App UI's destructor.
IMPORT_C TInt PrepareToExit (TUint32 aAppUid, TUint32 aViewId, TUint32 aCustomMessageId)
 Client Apps can call this function in the App UI's destructor.
IMPORT_C void HandleDownloadL (RHttpDownload &aDownload)
 Currently it supports handling completed download.
TInt DownloadConfirmationsShown () const
 The number of download confirmations being shown.
TBool IsUiBusy () const
 Ask if a handler or something uses the UI, so others should postpone their tasks that require UI.
TBool IsCodServiceFlowRunning () const
 Is a Cod ServiceFlow running?
TBool IsCodServiceFlowRunning (RHttpDownload &aDownload) const
 Is Cod ServiceFlow running of the given download?
TBool IsCodServiceFlowRunningL () const
 Is a Cod ServiceFlow running? LEAVing version.
TBool IsCodServiceFlowRunningL (RHttpDownload &aDownload) const
 Is Cod ServiceFlow running of the given download? LEAVing version.
void PostponeCodHandlingL (RHttpDownload &aDownload)
 Postpone handling the given COD download.
TBool IsPostponed (RHttpDownload &aDownload) const
 Check if the given download is postponed.
void SchedulePostponedDownloadL ()
 Schedule a postponed download for running.
virtual IMPORT_C void GetIntAttributeL (const TUint aAttribute, TInt32 &aValue)
 Gets the value for a TInt attribute.
virtual IMPORT_C void GetBoolAttributeL (const TUint aAttribute, TBool &aValue)
 Gets the value for a TBool attribute.
virtual IMPORT_C void GetStringAttributeL (const TUint aAttribute, TDes16 &aValue)
 Gets the value for a TDes16 attribute.
virtual IMPORT_C void GetStringAttributeL (const TUint aAttribute, TDes8 &aValue)
 Gets the value for a TDes8 attribute.
virtual IMPORT_C void SetIntAttributeL (const TUint aAttribute, TInt32 aValue)
 Sets the value for a TInt attribute.
virtual IMPORT_C void SetBoolAttributeL (const TUint aAttribute, TBool aValue)
 Sets the value for a TBool attribute.
virtual IMPORT_C void SetStringAttributeL (const TUint aAttribute, const TDesC16 &aValue)
 Sets the value for a TDesC attribute.
virtual IMPORT_C void SetStringAttributeL (const TUint aAttribute, const TDesC8 &aValue)
 Sets the value for a TDesC8 attribute.

Static Public Member Functions

static CDownloadMgrUiUserInteractions * NewL (CDownloadMgrUiLibRegistry &aRegistryModel)
 Two-phased constructor.

Protected Member Functions

 CDownloadMgrUiUserInteractions (CDownloadMgrUiLibRegistry &aRegistryModel)
 C++ default constructor.
void ConstructL ()
 By default Symbian 2nd phase constructor is private.
void HandleCompletionWithQueryL (RHttpDownload &aDownload, TBool aIsUiBusy, TBool aIsSupported, TBool aIsDrm, TBool aDrmRightsOnPhone)
 Wraps DoHandleCompletionWithQueryL() to ensure that only one instance of the dialog is displayed at any point in time.
void DoHandleCompletionWithQueryL (RHttpDownload &aDownload, TBool aIsUiBusy, TBool aIsSupported, TBool aIsDrm, TBool aDrmRightsOnPhone)
 Handle download completion with query (wait) dialog.
void PrepareToExitL (CEikAppUi *aAppUi, TClientAppExitType aExitType, TVwsViewId aViewId, TUid aCustomMessageId, const TDesC8 &aViewActivationMsg)
 Leaving version of PrepareToExit().
TBool IsStandAloneAppRunning ()
 Is a stand-alone instance running from the very same application?
void DeleteEventHandlerShowingDlConfirmation (RHttpDownload &aDownload)
 Delete Event Handler(s) showing download confirmation query.
void DeleteEventHandlers (RHttpDownload &aDownload)
 Delete Event Handler(s) belonging to the given download.
void HandleNormalDownloadL (RHttpDownload &aDownload)
 Handle completed normal download (not COD or OMA, not DRM).
TBool CodDownloadL (RHttpDownload &aDownload) const
 Check if the download is COD.
virtual void HandleDMgrEventL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
 Indicates an event.

Friends

class CUserInteractionsExtension

Member Enumeration Documentation

enum CDownloadMgrUiUserInteractions::TDownloadMgrUiUserInteractionsAttr
 

Attribute enumerations.

Enumerator:
EAttrSuppressDownloadConfirmation  TBool, default: EFalse.

Constructor & Destructor Documentation

virtual CDownloadMgrUiUserInteractions::~CDownloadMgrUiUserInteractions (   )  [virtual]
 

Destructor.

CDownloadMgrUiUserInteractions::CDownloadMgrUiUserInteractions ( CDownloadMgrUiLibRegistry &  aRegistryModel  )  [protected]
 

C++ default constructor.

Member Function Documentation

TBool CDownloadMgrUiUserInteractions::CodDownloadL ( RHttpDownload &  aDownload  )  const [protected]
 

Check if the download is COD.

Parameters:
aDownload The actual download
Returns:
ETrue/EFalse
void CDownloadMgrUiUserInteractions::ConstructL (   )  [protected]
 

By default Symbian 2nd phase constructor is private.

void CDownloadMgrUiUserInteractions::DeleteEventHandlers ( RHttpDownload &  aDownload  )  [protected]
 

Delete Event Handler(s) belonging to the given download.

Parameters:
aDownload The actual download.
void CDownloadMgrUiUserInteractions::DeleteEventHandlerShowingDlConfirmation ( RHttpDownload &  aDownload  )  [protected]
 

Delete Event Handler(s) showing download confirmation query.

Parameters:
aDownload The actual download.
void CDownloadMgrUiUserInteractions::DoHandleCompletionWithQueryL ( RHttpDownload &  aDownload,
TBool  aIsUiBusy,
TBool  aIsSupported,
TBool  aIsDrm,
TBool  aDrmRightsOnPhone
)  [protected]
 

Handle download completion with query (wait) dialog.

Parameters:
aDownload The actual download
Returns:
-
TInt CDownloadMgrUiUserInteractions::DownloadConfirmationsShown (   )  const
 

The number of download confirmations being shown.

Returns:
Non-negative integer value.
virtual IMPORT_C void CDownloadMgrUiUserInteractions::GetBoolAttributeL ( const TUint  aAttribute,
TBool &  aValue
)  [virtual]
 

Gets the value for a TBool attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TBool attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::GetIntAttributeL ( const TUint  aAttribute,
TInt32 &  aValue
)  [virtual]
 

Gets the value for a TInt attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TInt attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::GetStringAttributeL ( const TUint  aAttribute,
TDes8 &  aValue
)  [virtual]
 

Gets the value for a TDes8 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TDes8 attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::GetStringAttributeL ( const TUint  aAttribute,
TDes16 &  aValue
)  [virtual]
 

Gets the value for a TDes16 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TDes16 attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

void CDownloadMgrUiUserInteractions::HandleCompletionWithQueryL ( RHttpDownload &  aDownload,
TBool  aIsUiBusy,
TBool  aIsSupported,
TBool  aIsDrm,
TBool  aDrmRightsOnPhone
)  [protected]
 

Wraps DoHandleCompletionWithQueryL() to ensure that only one instance of the dialog is displayed at any point in time.

Parameters:
aDownload The actual download
Returns:
void
virtual void CDownloadMgrUiUserInteractions::HandleDMgrEventL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected, virtual]
 

Indicates an event.

Parameters:
aDownload The download with which the event occured.
aEvent Event type.
Returns:
None.

Implements MHttpDownloadMgrObserver.

IMPORT_C void CDownloadMgrUiUserInteractions::HandleDownloadL ( RHttpDownload &  aDownload  ) 
 

Currently it supports handling completed download.

COD download is deleted, otherwise normal behaviour, that depends on EDlAttrAction (EDoNothing/EMove/ELaunch).

Parameters:
aDownload The actual download
Returns:
-
void CDownloadMgrUiUserInteractions::HandleNormalDownloadL ( RHttpDownload &  aDownload  )  [protected]
 

Handle completed normal download (not COD or OMA, not DRM).

Parameters:
aDownload The actual download
Returns:
-
TBool CDownloadMgrUiUserInteractions::IsCodServiceFlowRunning ( RHttpDownload &  aDownload  )  const
 

Is Cod ServiceFlow running of the given download?

Parameters:
aDownload The download in question.
Returns:
yes/no.
TBool CDownloadMgrUiUserInteractions::IsCodServiceFlowRunning (   )  const
 

Is a Cod ServiceFlow running?

Returns:
yes/no.
TBool CDownloadMgrUiUserInteractions::IsCodServiceFlowRunningL ( RHttpDownload &  aDownload  )  const
 

Is Cod ServiceFlow running of the given download? LEAVing version.

Parameters:
aDownload The download in question.
Returns:
yes/no.
TBool CDownloadMgrUiUserInteractions::IsCodServiceFlowRunningL (   )  const
 

Is a Cod ServiceFlow running? LEAVing version.

Returns:
yes/no.
TBool CDownloadMgrUiUserInteractions::IsPostponed ( RHttpDownload &  aDownload  )  const
 

Check if the given download is postponed.

Parameters:
aDownload The download in question.
Returns:
true/false.
TBool CDownloadMgrUiUserInteractions::IsStandAloneAppRunning (   )  [protected]
 

Is a stand-alone instance running from the very same application?

Returns:
True/False.
TBool CDownloadMgrUiUserInteractions::IsUiBusy (   )  const
 

Ask if a handler or something uses the UI, so others should postpone their tasks that require UI.

Returns:
yes/no.
static CDownloadMgrUiUserInteractions* CDownloadMgrUiUserInteractions::NewL ( CDownloadMgrUiLibRegistry &  aRegistryModel  )  [static]
 

Two-phased constructor.

IMPORT_C TBool CDownloadMgrUiUserInteractions::OkToExitL (   ) 
 

Client Apps can call this function before exiting the application.

It should be called when the user terminates the application. It opens a confirmation query.

Returns:
OK to exit? True/False. It is only a suggested value!
void CDownloadMgrUiUserInteractions::PostponeCodHandlingL ( RHttpDownload &  aDownload  ) 
 

Postpone handling the given COD download.

The download is placed to a LIFO queue, and SetHandlerRunning( EFalse ) handles (restarts) the first download in it.

Parameters:
aDownload The download to be postponed.
IMPORT_C TInt CDownloadMgrUiUserInteractions::PrepareToExit ( TUint32  aAppUid,
TUint32  aViewId,
TUint32  aCustomMessageId
) 
 

Client Apps can call this function in the App UI's destructor.

It has been made non-leavable, so it can be called without TRAP. It initializes Grouped Soft Notifications, if necessary.

Parameters:
aAppUid 3rd UID of the application.
aViewId View ID that needs to be activated.
aCustomMessageId Custom message ID.
Returns:
Error code or KErrNone.
IMPORT_C TInt CDownloadMgrUiUserInteractions::PrepareToExit ( CEikAppUi &  aAppUi,
TClientAppExitType  aExitType,
TVwsViewId  aViewId,
TUid  aCustomMessageId,
const TDesC8 &  aViewActivationMsg
) 
 

Client Apps can call this function in the App UI's destructor.

It has been made non-leavable, so it can be called without TRAP. It initializes Grouped Soft Notifications, if necessary.

Parameters:
aAppUi Reference to the actual App UI.
aExitType Exit type when this function is called. Only ETerminatedBySystem is supported.
aViewId View ID of the view where to switch in case user chooses accept softkey in the soft notification.
aCustomMessageId Custom message ID.
aViewActivationMsg Custom message sent to the view in the view activation process.
Returns:
Error code or KErrNone.
void CDownloadMgrUiUserInteractions::PrepareToExitL ( CEikAppUi *  aAppUi,
TClientAppExitType  aExitType,
TVwsViewId  aViewId,
TUid  aCustomMessageId,
const TDesC8 &  aViewActivationMsg
)  [protected]
 

Leaving version of PrepareToExit().

Returns:
None.
void CDownloadMgrUiUserInteractions::SchedulePostponedDownloadL (   ) 
 

Schedule a postponed download for running.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::SetBoolAttributeL ( const TUint  aAttribute,
TBool  aValue
)  [virtual]
 

Sets the value for a TBool attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::SetIntAttributeL ( const TUint  aAttribute,
TInt32  aValue
)  [virtual]
 

Sets the value for a TInt attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::SetStringAttributeL ( const TUint  aAttribute,
const TDesC8 &  aValue
)  [virtual]
 

Sets the value for a TDesC8 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiUserInteractions::SetStringAttributeL ( const TUint  aAttribute,
const TDesC16 &  aValue
)  [virtual]
 

Sets the value for a TDesC attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

Friends And Related Function Documentation

friend class CUserInteractionsExtension [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top