The DownloadManagerReport class details the outcome of processing an AsyncDownloadManager or SyncDownloadManager queue.

#include <qx/network/qx-downloadmanager.h>

Collaboration diagram for Qx::DownloadManagerReport:

Public Types
enum class	Outcome { Success = 0x0 , Fail = 0x1 , Abort = 0x2 }

Public Member Functions
	DownloadManagerReport ()

qsizetype	aborted () const

QString	details () const

QString	generalDetails () const

bool	isNull () const

Outcome	outcome () const

QString	outcomeString () const

qsizetype	skipped () const

QString	specificDetails () const

QList< DownloadOpReport >	taskReports () const

bool	wasSuccessful () const

Public Member Functions inherited from Qx::AbstractError<"Qx::DownloadManagerReport", 3 >
	operator bool () const

bool	operator!= (const AbstractError &other) const=default

bool	operator== (const AbstractError &other) const=default

Additional Inherited Members
Static Public Attributes inherited from Qx::AbstractError<"Qx::DownloadManagerReport", 3 >
static constexpr quint16	TYPE_CODE

static constexpr QLatin1StringView	TYPE_NAME

Protected Member Functions inherited from Qx::IError
	IError ()=default

virtual QString	deriveCaption () const

virtual Severity	deriveSeverity () const

bool	operator!= (const IError &other) const =default

bool	operator== (const IError &other) const =default

Member Enumeration Documentation

◆ Outcome

enum class Qx::DownloadManagerReport::Outcome

strong

This enum represents the outcome of a processed download manager queue.

Enumerator
Success	A queue that finished processing successfully.
Fail	A queue that failed to process completely.
Abort	A queue that was aborted in-progress.

Constructor & Destructor Documentation

◆ DownloadManagerReport()

Qx::DownloadManagerReport::DownloadManagerReport ( )

Constructs a null download manager report

Member Function Documentation

◆ aborted()

qsizetype Qx::DownloadManagerReport::aborted ( ) const

Returns the number of downloads that were aborted, if any.

◆ details()

QString Qx::DownloadManagerReport::details ( ) const

Returns all extended error information, if present.

◆ generalDetails()

QString Qx::DownloadManagerReport::generalDetails ( ) const

Returns general extended error information, if present.

◆ isNull()

bool Qx::DownloadManagerReport::isNull ( ) const

Returns true if the report is null; otherwise, returns false.

◆ outcome()

DownloadManagerReport::Outcome Qx::DownloadManagerReport::outcome ( ) const

Returns the overall processing outcome of the download manager the report was generated from.

◆ outcomeString()

QString Qx::DownloadManagerReport::outcomeString ( ) const

Returns a string representation of the report outcome.

◆ skipped()

qsizetype Qx::DownloadManagerReport::skipped ( ) const

Returns the number of downloads that were skipped, if any.

◆ specificDetails()

QString Qx::DownloadManagerReport::specificDetails ( ) const

Returns download task specific extended error information, if present.

◆ taskReports()

QList< DownloadOpReport > Qx::DownloadManagerReport::taskReports ( ) const

Returns reports detailing the result of each individual download task that was part of the generating manager's queue.

◆ wasSuccessful()

bool Qx::DownloadManagerReport::wasSuccessful ( ) const

Returns true if the download manager that generated this report processed its queue successfully; otherwise returns false.

The documentation for this class was generated from the following files:

qx-downloadmanagerreport.h
qx-downloadmanagerreport.cpp

Public Types

Public Member Functions

Additional Inherited Members