DownloadSummary 编辑

Provides an aggregated view on the contents of a DownloadList.

A reference to a DownloadSummary object can be obtained using the Downloads.getSummary() function.

Method overview

Properties

Methods

bindToList()

This method may be called once to bind this object to a DownloadList.

Views on the summarized data can be registered before this object is bound to an actual list. This allows the summary to be used without requiring the initialization of the DownloadList first.

Promise bindToList(
  DownloadList aList
);

Parameters

aList

Underlying DownloadList whose contents should be summarized.

Promise resolves to

undefined when the view on the underlying list has been registered.

addView()

Adds a view that will be notified of changes to the summary. The newly added view will receive an initial onSummaryChanged notification.

Promise addView(
  Object aView
);

Parameters

aView

The view object to add. The following methods may be defined:

• onSummaryChanged: Optional Called after any property of the summary has changed.

Promise resolves to

undefined when the view has been registered and the onSummaryChanged notification has been sent.

removeView()

Removes a view that was previously added using addView().

Promise removeView(
  Object aView
);

Parameters

aView

The view object to remove.

Promise resolves to

undefined when the view has been removed. At this point, the removed view will not receive any more notifications.

See also

• Downloads.jsm