Public Member Functions | Public Attributes

nsIDOMOfflineResourceList Interface Reference

import "nsIDOMOfflineResourceList.idl";

Collaboration diagram for nsIDOMOfflineResourceList:

List of all members.

Public Member Functions

boolean mozHasItem (in DOMString uri)
 Check that an entry exists in the list of dynamically-managed entries.
DOMString mozItem (in unsigned long index)
 Get the URI of a dynamically-managed entry.
void mozAdd (in DOMString uri)
 Add an item to the list of dynamically-managed entries.
void mozRemove (in DOMString uri)
 Remove an item from the list of dynamically-managed entries.
void update ()
 Begin the application update process on the associated application cache.
void swapCache ()
 Swap in the newest version of the application cache, or disassociate from the cache if the cache group is obsolete.

Public Attributes

readonly attribute
nsIDOMDOMStringList 
mozItems
 Get the list of dynamically-managed entries.
readonly attribute unsigned long mozLength
 Get the number of dynamically-managed entries.
const unsigned short UNCACHED = 0
 State of the application cache this object is associated with.
const unsigned short IDLE = 1
const unsigned short CHECKING = 2
const unsigned short DOWNLOADING = 3
const unsigned short UPDATEREADY = 4
const unsigned short OBSOLETE = 5
readonly attribute unsigned short status
attribute nsIDOMEventListener onchecking
attribute nsIDOMEventListener onerror
attribute nsIDOMEventListener onnoupdate
attribute nsIDOMEventListener ondownloading
attribute nsIDOMEventListener onprogress
attribute nsIDOMEventListener onupdateready
attribute nsIDOMEventListener oncached
attribute nsIDOMEventListener onobsolete

Member Function Documentation

void nsIDOMOfflineResourceList::mozAdd ( in DOMString  uri  ) 

Add an item to the list of dynamically-managed entries.

The resource will be fetched into the application cache.

Parameters:
uri The resource to add.
boolean nsIDOMOfflineResourceList::mozHasItem ( in DOMString  uri  ) 

Check that an entry exists in the list of dynamically-managed entries.

Parameters:
uri The resource to check.
DOMString nsIDOMOfflineResourceList::mozItem ( in unsigned long  index  ) 

Get the URI of a dynamically-managed entry.

Status:
DEPRECATED Clients should use the "items" attribute.
void nsIDOMOfflineResourceList::mozRemove ( in DOMString  uri  ) 

Remove an item from the list of dynamically-managed entries.

If this was the last reference to a URI in the application cache, the cache entry will be removed.

Parameters:
uri The resource to remove.
void nsIDOMOfflineResourceList::swapCache (  ) 

Swap in the newest version of the application cache, or disassociate from the cache if the cache group is obsolete.

void nsIDOMOfflineResourceList::update (  ) 

Begin the application update process on the associated application cache.


Member Data Documentation

const unsigned short nsIDOMOfflineResourceList::CHECKING = 2
const unsigned short nsIDOMOfflineResourceList::DOWNLOADING = 3
const unsigned short nsIDOMOfflineResourceList::IDLE = 1

Get the list of dynamically-managed entries.

readonly attribute unsigned long nsIDOMOfflineResourceList::mozLength

Get the number of dynamically-managed entries.

Status:
DEPRECATED Clients should use the "items" attribute.
const unsigned short nsIDOMOfflineResourceList::OBSOLETE = 5
readonly attribute unsigned short nsIDOMOfflineResourceList::status
const unsigned short nsIDOMOfflineResourceList::UNCACHED = 0

State of the application cache this object is associated with.

const unsigned short nsIDOMOfflineResourceList::UPDATEREADY = 4

The documentation for this interface was generated from the following file: