Symbian^3 Application Developer Library >

MNcdDownloadOperation Class Reference

class MNcdDownloadOperation : public MNcdOperation

Download operation interface.

A download operation handles the downloading of one or more files.

The files are downloaded consecutively and in a predefined order. If parallel downloading is desired, multiple operations can be started.

Common uses for download operatios are downloading a downloadable node's content and downloading graphics for nodes.

Download operations can be queried for the number of the download that is currently being downloaded. The progress information is always relative to the current download.

MNcdDownloadOperationObserver MNcdNodeDownload

Inherits from

Public Member Functions
void AddObserverL ( MNcdDownloadOperationObserver &)
TInt CurrentFile ()
TNcdDownloadDataType DownloadDataType ()
TInt FileCount ()
TBool IsPausableL ()
TBool IsPaused ()
void PauseL ()
TBool RemoveObserver ( MNcdDownloadOperationObserver &)
void ResumeL ()
Protected Member Functions
~MNcdDownloadOperation ()
Inherited Functions
MCatalogsBase::AddRef()const
MCatalogsBase::QueryInterfaceL()
MCatalogsBase::QueryInterfaceL()const
MCatalogsBase::QueryInterfaceL(TInt)const
MCatalogsBase::QueryInterfaceLC()
MCatalogsBase::QueryInterfaceLC()const
MCatalogsBase::Release()const
MCatalogsBase::~MCatalogsBase()
MNcdOperation::CancelOperation()
MNcdOperation::CompleteQueryL(MNcdQuery &)
MNcdOperation::Node()
MNcdOperation::OperationStateL()const
MNcdOperation::OperationType()const
MNcdOperation::Progress()const
MNcdOperation::StartOperationL()
MNcdOperation::~MNcdOperation()
Inherited Enumerations
MCatalogsBase:@46
MNcdOperation:@51
MNcdOperation:TState

Constructor & Destructor Documentation

~MNcdDownloadOperation()

~MNcdDownloadOperation ( ) [protected, inline, virtual]

Destructor.

MCatalogsBase::~MCatalogsBase

Member Functions Documentation

AddObserverL(MNcdDownloadOperationObserver &)

void AddObserverL ( MNcdDownloadOperationObserver & aObserver ) [pure virtual]

Add a new observer for this download operation.

If the observer has already been added, this function doesn't do anything.

Exceptions
Leave

System wide error code.

Parameters

MNcdDownloadOperationObserver & aObserver

CurrentFile()

TInt CurrentFile ( ) [pure virtual]

Getter for current file number. This is the number of the file that is currently being downloaded.

DownloadDataType()

TNcdDownloadDataType DownloadDataType ( ) const [pure virtual]

Download data type getter

ncdoperationdatatypes.h

FileCount()

TInt FileCount ( ) [pure virtual]

Getter for file count. This is the total number of files this operation is downloading.

IsPausableL()

TBool IsPausableL ( ) [pure virtual]

Can download be paused

leave
Symbian error code
Note:

Some DRM content is not pausable

Pausable state may change during the operation

IsPaused()

TBool IsPaused ( ) [pure virtual]

Return the paused state of the download.

PauseL()

void PauseL ( ) [pure virtual]

Pause the download.

Note:

Does nothing if the download was already paused, or if the operation is not yet started.

Exceptions
Leave

System wide error code.

RemoveObserver(MNcdDownloadOperationObserver &)

TBool RemoveObserver ( MNcdDownloadOperationObserver & aObserver ) [pure virtual]

Remove an observer previously added with AddObserverL() .

Parameters

MNcdDownloadOperationObserver & aObserver

ResumeL()

void ResumeL ( ) [pure virtual]

Resume a paused download.

Note:

Does nothing if the download has not been paused, or if the operation is not yet started.

Exceptions
Leave

System wide error code.

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.