RHttpDownload Class Reference

API published in: S60 2nd Ed FP 3

Link against: downloadmgr.lib

Capability Information

Required Capabilities

None

Exceptions

The capability NetworkServices is required in: RHttpDownloadMgr::ConnectL( TUid aAppUid, MHttpDownloadMgrObserver& aObserver, TBool aMaster)

#include <downloadmgrclient.h>

Detailed Description

Creates a download manager subsession and performs operations on it.

Public Member Functions
IMPORT_C TInt  Start ()
  Starts downloading.
IMPORT_C TInt  Pause ()
  Pauses downloading.
IMPORT_C TInt  Reset ()
  Resets downloading.
IMPORT_C TInt  Delete ()
  Deletes downloading.
IMPORT_C TInt  Move ()
  Moves downloaded content to the previously specified location.
IMPORT_C TInt  GetIntAttribute (const TUint aAttribute, TInt32 &aValue)
  Gets the value for a TInt attribute.
IMPORT_C TInt  GetBoolAttribute (const TUint aAttribute, TBool &aValue)
  Gets the value for a TBool attribute.
IMPORT_C TInt  GetStringAttribute (const TUint aAttribute, TDes16 &aValue)
  Gets the value for a TDes16 attribute.
IMPORT_C TInt  GetStringAttribute (const TUint aAttribute, TDes8 &aValue)
  Gets the value for a TDes8 attribute.
IMPORT_C TInt  GetFileHandleAttribute (RFile &aFile)
  Gets the download's destination file's handle.
IMPORT_C TInt  SetIntAttribute (const TUint aAttribute, TInt32 aValue)
  Sets the value for a TInt attribute.
IMPORT_C TInt  SetBoolAttribute (const TUint aAttribute, TBool aValue)
  Sets the value for a TDesC attribute.
IMPORT_C TInt  SetStringAttribute (const TUint aAttribute, const TDesC16 &aValue)
  Sets the value for a TDesC attribute.
IMPORT_C TInt  SetStringAttribute (const TUint aAttribute, const TDesC8 &aValue)
  Sets the value for a TDesC8 attribute.
IMPORT_C TInt  SetFileHandleAttribute (RFile &aFile)
  Sets the download's destination file handle.
void  Close ()
  Closes download subsession.
TBool  IsClosed ()
  Indicates whether the download is closed.

Friends
class  CDownloadMgrHandler
class  RHttpDownloadMgr
class  RHttpDownloadMgrApiExt
class  CTransactionObserver
class  CCodObserver

Member Function Documentation

void RHttpDownload::Close (   ) 
 

Closes download subsession.

Parameters:
- 
Returns:
None.
IMPORT_C TInt RHttpDownload::Delete (   ) 
 

Deletes downloading.

Parameters:
- 
Returns:
None.
IMPORT_C TInt RHttpDownload::GetBoolAttribute (  const TUint  aAttribute,
TBool &  aValue
) 
 

Gets the value for a TBool attribute.

Parameters:
aAttribute  Identifies the attribute to be retrived.
aValue  On completion, contains the requested TBool attribute.
Returns:
None.
IMPORT_C TInt RHttpDownload::GetFileHandleAttribute (  RFile &  aFile  ) 
 

Gets the download's destination file's handle.

Parameters:
aFile  RFile that adopts file handle from download.
IMPORT_C TInt RHttpDownload::GetIntAttribute (  const TUint  aAttribute,
TInt32 &  aValue
) 
 

Gets the value for a TInt attribute.

Parameters:
aAttribute  Identifies the attribute to be retrived.
aValue  On completion, contains the requested TInt attribute.
Returns:
None.
IMPORT_C TInt RHttpDownload::GetStringAttribute (  const TUint  aAttribute,
TDes8 &  aValue
) 
 

Gets the value for a TDes8 attribute.

Parameters:
aAttribute  Identifies the attribute to be retrived.
aValue  On completion, contains the requested TDes8 attribute.
Returns:
None.
IMPORT_C TInt RHttpDownload::GetStringAttribute (  const TUint  aAttribute,
TDes16 &  aValue
) 
 

Gets the value for a TDes16 attribute.

Parameters:
aAttribute  Identifies the attribute to be retrived.
aValue  On completion, contains the requested TDes16 attribute.
Returns:
None.
TBool RHttpDownload::IsClosed (   )  [inline]
 

Indicates whether the download is closed.

Parameters:
-  None
Returns:
TBool - ETrue if download is closed else EFalse.
IMPORT_C TInt RHttpDownload::Move (   ) 
 

Moves downloaded content to the previously specified location.

Parameters:
- 
Returns:
None.
IMPORT_C TInt RHttpDownload::Pause (   ) 
 

Pauses downloading.

Parameters:
- 
Returns:
None.
IMPORT_C TInt RHttpDownload::Reset (   ) 
 

Resets downloading.

Parameters:
- 
Returns:
None.
IMPORT_C TInt RHttpDownload::SetBoolAttribute (  const TUint  aAttribute,
TBool  aValue
) 
 

Sets the value for a TDesC attribute.

Parameters:
aAttribute  Identifies the attribute to be set.
aValue  The value to be set.
Returns:
None.
IMPORT_C TInt RHttpDownload::SetFileHandleAttribute (  RFile &  aFile  ) 
 

Sets the download's destination file handle.

Parameters:
aFile  RFile to be transfered to server.
Returns:
KErrNotSupported on non-support platform.

KErrBadHandle is file is not opened.

IMPORT_C TInt RHttpDownload::SetIntAttribute (  const TUint  aAttribute,
TInt32  aValue
) 
 

Sets the value for a TInt attribute.

Parameters:
aAttribute  Identifies the attribute to be set.
aValue  The value to be set.
Returns:
None.
IMPORT_C TInt RHttpDownload::SetStringAttribute (  const TUint  aAttribute,
const TDesC8 &  aValue
) 
 

Sets the value for a TDesC8 attribute.

Parameters:
aAttribute  Identifies the attribute to be set.
aValue  The value to be set.
Returns:
None.
IMPORT_C TInt RHttpDownload::SetStringAttribute (  const TUint  aAttribute,
const TDesC16 &  aValue
) 
 

Sets the value for a TDesC attribute.

Parameters:
aAttribute  Identifies the attribute to be set.
aValue  The value to be set.
Returns:
None.
IMPORT_C TInt RHttpDownload::Start (   ) 
 

Starts downloading.

Parameters:
- 
Returns:
None.

Friends And Related Function Documentation

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