Symbian^3 Product Developer Library >

multimedia::CDownloadGateway Class Reference

class multimedia::CDownloadGateway : public MHttpDownloadMgrObserver
Implements the Gateway from which the Clients talk to the DownloadMgr. Provides functionality to the Clients to query attributes from the Browser EnhancedMediaClient.lib
Since
S60 v3.2

Inherits from

Public Member Functions
CDownloadGateway()
~CDownloadGateway()
TInt ConnectToDownload(TInt, MDownloadGatewayObserver &, TUid)
TInt DeleteDownload(TInt)
TInt DisconnectFromDownload(TInt)
TInt GetCurrentSize(TInt, TUint &)
TInt GetDownloadSize(TInt, TUint &)
TInt GetDownloadStatus(TInt, MProgDLSource::TDownloadStatus &)
TInt GetLocalFileName(TInt, TDes &)
TInt GetMimeType(TInt, TDes8 &)
voidHandleDMgrEventL(RHttpDownload &, THttpDownloadEvent)
TInt Initialize(TUid)
TInt MoveFile(TInt, const TDesC &)
TInt ResumeDownload(TInt)
TInt SetLocalFileName(TInt, TDesC &)
TInt SetProgressiveMode(TInt, TBool)
Private Attributes
TBool iDMgrConnected
RHttpDownload *iDownload
TInt iDownloadId
RHttpDownloadMgrApiExt iDownloadMgr
MProgDLSource::TDownloadStatus iDownloadStatus
MDownloadGatewayObserver *iObserver
THttpDownloadEventiPrevEvent

Constructor & Destructor Documentation

CDownloadGateway()

CDownloadGateway()

Function to Create the Object.

~CDownloadGateway()

~CDownloadGateway()

Destructor.

Member Functions Documentation

ConnectToDownload(TInt, MDownloadGatewayObserver &, TUid)

TInt ConnectToDownload(TIntaId,
MDownloadGatewayObserver &aObserver,
TUidaAppUid
)
Called by the Client which wants to Connect to the Download
Since
S60 v3.2

Parameters

TInt aIdTransactionID for which the File has to be moved.
MDownloadGatewayObserver & aObserverObserver where the Client wants the Callbacks
TUid aAppUidUID for the App which Connects.

DeleteDownload(TInt)

TInt DeleteDownload(TIntaId)
Cancelling a Particular Download
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Download to be deleted

DisconnectFromDownload(TInt)

TInt DisconnectFromDownload(TIntaId)
Disconnect from the Download Here it connect to the DownloadMgr Server.
Since
S60 v3.2

Parameters

TInt aIdDownloadID from which the Client wants to Disconnect.

GetCurrentSize(TInt, TUint &)

TInt GetCurrentSize(TIntaId,
TUint &aSize
)
Gets the Current Downloaded Size of the Download
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Download which the FileSize is queried.
TUint & aSizeSize of the Download returned

GetDownloadSize(TInt, TUint &)

TInt GetDownloadSize(TIntaId,
TUint &aSize
)
Total Size of the File which is being downloaded Here it connect to the DownloadMgr Server.
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Download which the FileSize is queried.
TUint & aSizeTotal Size of the File being Downloaded returned

GetDownloadStatus(TInt, MProgDLSource::TDownloadStatus &)

TInt GetDownloadStatus(TIntaTxId,
MProgDLSource::TDownloadStatus &aStatus
)
Gets the Download Status for a particular Download
Since
S60 v3.2

Parameters

TInt aTxId
MProgDLSource::TDownloadStatus & aStatusDownload Status for the Download

GetLocalFileName(TInt, TDes &)

TInt GetLocalFileName(TIntaId,
TDes &aFileName
)
Gets the Local FileName from the DownloadMgr
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Dowload to be Resumed
TDes & aFileNameGets the FileName from the DownloadMgr

GetMimeType(TInt, TDes8 &)

TInt GetMimeType(TIntaId,
TDes8 &aMimeType
)
Queries the MimeType of the File from the DownloadMgr
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Download to be queried
TDes8 & aMimeTypeMimeType returned from the Browser.

HandleDMgrEventL(RHttpDownload &, THttpDownloadEvent)

voidHandleDMgrEventL(RHttpDownload &aDownload,
THttpDownloadEventaEvent
)[virtual]
From MhttpDownloadMgrObserver. Callback from the DownloadManager notifying Client Events.
Since
S60 v3.2

Parameters

RHttpDownload & aDownloadDownload for which the Event is meant
THttpDownloadEvent aEventActual Event

Initialize(TUid)

TInt Initialize(TUidaClientUid)
Initialize the Gateway with the Client UID. Here it connect to the DownloadMgr Server.
Since
S60 v3.2

Parameters

TUid aClientUidClient which wants to connect.

MoveFile(TInt, const TDesC &)

TInt MoveFile(TIntaId,
const TDesC &aDestFileName
)
Calls Move on the DownloadMgr for the TransactionID
Since
S60 v3.2

Parameters

TInt aIdTransactionID for which the File has to be moved.
const TDesC & aDestFileNameFull Pathname where the file needs to be moved.

ResumeDownload(TInt)

TInt ResumeDownload(TIntaId)
Resuming a Paused Download
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Download to be Resumed

SetLocalFileName(TInt, TDesC &)

TInt SetLocalFileName(TIntaId,
TDesC &aFileName
)
Before Calling Move we need to Call this to set the Local FileName
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Dowload for setting the FileName
TDesC & aFileNameName to be Set

SetProgressiveMode(TInt, TBool)

TInt SetProgressiveMode(TIntaId,
TBoolaMode
)
Tells the Browser if the Download is being Progressively Played
Since
S60 v3.2

Parameters

TInt aIdTransactionID of the Dowload to be Resumed
TBool aModeWhether the Mode is True or False.

Member Data Documentation

TBool iDMgrConnected

TBool iDMgrConnected[private]

RHttpDownload * iDownload

RHttpDownload *iDownload[private]

TInt iDownloadId

TInt iDownloadId[private]

RHttpDownloadMgrApiExt iDownloadMgr

RHttpDownloadMgrApiExt iDownloadMgr[private]

MProgDLSource::TDownloadStatus iDownloadStatus

MProgDLSource::TDownloadStatus iDownloadStatus[private]

MDownloadGatewayObserver * iObserver

MDownloadGatewayObserver *iObserver[private]

THttpDownloadEvent iPrevEvent

THttpDownloadEventiPrevEvent[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.