RHttpDownload Class Reference

#include <mw/downloadmgrclient.h>

class RHttpDownload : public RSubSessionBase

Inherits from

RHttpDownload

Public Member Enumerations
enum	TCodProgressState { ENotActive, EPaused, EInProgress }

Public Member Functions
void	Close()
IMPORT_C TInt	Delete()
IMPORT_C TInt	GetBoolAttribute(const TUint, TBool &)
IMPORT_C TInt	GetBoolAttribute(const TUint, const TInt32 &, TBool &)
IMPORT_C TInt	GetFileHandleAttribute(RFile &)
IMPORT_C TInt	GetIntAttribute(const TUint, TInt32 &)
IMPORT_C TInt	GetIntAttribute(const TUint, const TInt32 &, TInt32 &)
TInt	GetProductDownloadedSize()
IMPORT_C TInt	GetStringAttribute(const TUint, TDes16 &)
IMPORT_C TInt	GetStringAttribute(const TUint, TDes8 &)
IMPORT_C TInt	GetStringAttribute(const TUint, const TInt32 &, TDes16 &)
IMPORT_C TInt	GetStringAttribute(const TUint, const TInt32 &, TDes8 &)
TBool	IsClosed()
IMPORT_C TInt	Move()
IMPORT_C TInt	Pause()
IMPORT_C TInt	Reset()
void	ResumeCodDownloadL()
IMPORT_C TInt	SetBoolAttribute(const TUint, TBool)
IMPORT_C TInt	SetDownloadDataAttribute(const TDesC8 &)
IMPORT_C TInt	SetFileHandleAttribute(RFile &)
IMPORT_C TInt	SetIntAttribute(const TUint, TInt32)
IMPORT_C TInt	SetStringAttribute(const TUint, const TDesC16 &)
IMPORT_C TInt	SetStringAttribute(const TUint, const TDesC8 &)
IMPORT_C TInt	SetStringAttribute(const TUint, const TInt32 &, const TDesC16 &)
IMPORT_C TInt	SetTrackDataAttribute(const TInt, const TDesC8 &)
IMPORT_C TInt	Start()

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

Detailed Description

Creates a download manager subsession and performs operations on it

Since: Series 60 2.8

Member Enumeration Documentation

Enum TCodProgressState

Cod download progress states

Enumerator	Value	Description
ENotActive
EPaused
EInProgress

Member Function Documentation

Close ( )

void

(

)

Closes download subsession.

Returns: None.

Delete ( )

IMPORT_C TInt

Delete

(

)

Deletes downloading.

Returns: None.

GetBoolAttribute ( const TUint, TBool & )

IMPORT_C TInt	GetBoolAttribute	(	const TUint	aAttribute,
			TBool &	aValue
		)

Gets the value for a TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TBool attribute.

Returns: None.

GetBoolAttribute ( const TUint, const TInt32 &, TBool & )

IMPORT_C TInt	GetBoolAttribute	(	const TUint	aAttribute,
			const TInt32 &	aMoIndex,
			TBool &	aValue
		)

Gets the value for a TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aMoIndex	Identifies the media object index.
aValue	On completion, contains the requested TBool attribute.

Returns: None.

GetFileHandleAttribute ( RFile & )

IMPORT_C TInt

GetFileHandleAttribute

(

RFile &

aFile

)

Gets the download's destination file's handle.

Parameter	Description
aFile	RFile that adopts file handle from download.

GetIntAttribute ( const TUint, TInt32 & )

IMPORT_C TInt	GetIntAttribute	(	const TUint	aAttribute,
			TInt32 &	aValue
		)

Gets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TInt attribute.

Returns: None.

GetIntAttribute ( const TUint, const TInt32 &, TInt32 & )

IMPORT_C TInt	GetIntAttribute	(	const TUint	aAttribute,
			const TInt32 &	aMoIndex,
			TInt32 &	aValue
		)

Gets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aMoIndex	Identifies the media object index.
aValue	On completion, contains the requested TInt attribute.

Returns: None.

GetProductDownloadedSize ( )

TInt

GetProductDownloadedSize

(

)

Get Downloaded Size of product.

Returns: TInt.

GetStringAttribute ( const TUint, TDes16 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			TDes16 &	aValue
		)

Gets the value for a TDes16 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TDes16 attribute.

Returns: None.

GetStringAttribute ( const TUint, TDes8 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			TDes8 &	aValue
		)

Gets the value for a TDes8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aValue	On completion, contains the requested TDes8 attribute.

Returns: None.

GetStringAttribute ( const TUint, const TInt32 &, TDes16 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			const TInt32 &	aMoIndex,
			TDes16 &	aValue
		)

Gets the value for a TDes16 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aMoIndex	Identifies the media object index.
aValue	On completion, contains the requested TDes16 attribute.

Returns: None.

GetStringAttribute ( const TUint, const TInt32 &, TDes8 & )

IMPORT_C TInt	GetStringAttribute	(	const TUint	aAttribute,
			const TInt32 &	aMoIndex,
			TDes8 &	aValue
		)

Gets the value for a TDes8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be retrived.
aMoIndex	Identifies the media object index.
aValue	On completion, contains the requested TDes8 attribute.

Returns: None.

IsClosed ( )

TBool

IsClosed

(

)

[inline]

Indicates whether the download is closed.

Returns: TBool - ETrue if download is closed else EFalse.

Move ( )

IMPORT_C TInt

Move

(

)

Moves downloaded content to the previously specified location

Returns: None.

Pause ( )

IMPORT_C TInt

Pause

(

)

Pauses downloading.

Returns: None.

Reset ( )

IMPORT_C TInt

Reset

(

)

Resets downloading.

Returns: None.

ResumeCodDownloadL ( )

void

ResumeCodDownloadL

(

)

Resume COD download.

Returns: None.

SetBoolAttribute ( const TUint, TBool )

IMPORT_C TInt	SetBoolAttribute	(	const TUint	aAttribute,
			TBool	aValue
		)

Sets the value for a TDesC attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetDownloadDataAttribute ( const TDesC8 & )

IMPORT_C TInt

SetDownloadDataAttribute

(

const TDesC8 &

aValue

)

Sets the download data (media information).

Parameter	Description
aValue	The value to be set.

Returns: None.

SetFileHandleAttribute ( RFile & )

IMPORT_C TInt

SetFileHandleAttribute

(

RFile &

aFile

)

Sets the download's destination file handle.

Parameter	Description
aFile	RFile to be transfered to server.

Returns: KErrNotSupported on non-support platform. KErrBadHandle is file is not opened.

SetIntAttribute ( const TUint, TInt32 )

IMPORT_C TInt	SetIntAttribute	(	const TUint	aAttribute,
			TInt32	aValue
		)

Sets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetStringAttribute ( const TUint, const TDesC16 & )

IMPORT_C TInt	SetStringAttribute	(	const TUint	aAttribute,
			const TDesC16 &	aValue
		)

Sets the value for a TDesC attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetStringAttribute ( const TUint, const TDesC8 & )

IMPORT_C TInt	SetStringAttribute	(	const TUint	aAttribute,
			const TDesC8 &	aValue
		)

Sets the value for a TDesC8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetStringAttribute ( const TUint, const TInt32 &, const TDesC16 & )

IMPORT_C TInt	SetStringAttribute	(	const TUint	aAttribute,
			const TInt32 &	aMoIndex,
			const TDesC16 &	aValue
		)

Sets the value for a TDesC attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aMoIndex	Identifies the media object index.
aValue	The value to be set.

Returns: None.

SetTrackDataAttribute ( const TInt, const TDesC8 & )

IMPORT_C TInt	SetTrackDataAttribute	(	const TInt	aIndex,
			const TDesC8 &	aValue
		)

Sets the download data (media information).

Parameter	Description
aValue	The value to be set.

Returns: None.

Start ( )

IMPORT_C TInt

Start

(

)

Starts downloading.

Returns: None.