Personal tools

WebAPI/ProposedDeviceStorageAPIWithNotifications

From MozillaWiki

Jump to: navigation, search

This page contains a draft of the proposed modification to the DeviceStorage API to include onchanged notifications.

API

partial interface Navigator {
  /**
   * type is an arbitrary string. On OSs with predefined directories (pictures,
   * music, etc) we can match certain type names to certain folders.
   * To be figured out.
   *
   * Note that each value for the type represents a different directory.
   * I.e. passing "pictures" as type will yield a completely different set
   * of files from passing "movies" as the type.
   *
   * In other words, the type argument is not some sort of filter, but rather
   * simply a destination directory.
   */
  DeviceStorage getDeviceStorage(DOMString type);
};

interface DeviceStorage : EventTarget {
  // Name will be generated by the implementation and returned as result of request
  DOMRequest add(Blob blob);

  // Fails if a file with the given name already exists.
  DOMRequest addNamed(Blob blob, DOMString name);

  // Returns the result as a File object
  DOMRequest get(DOMString name);

  // Returns the result as a FileHandle object which enables writing
  DOMRequest getEditable(DOMString name);

  // Deletes a file
  DOMRequest delete(DOMString name);

  // Adds a listener for a file update event.
  // The type determines what type of event to listen for: one of "created","deleted", and "modified".
  // The listener recieves notification when an event occurs
  // If true, useCapture indicates that the user wishes to initiate capture. After initiating capture, all events of the specified type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree.
  void addEventListener(DOMString type, EventListener listener, optional boolean useCapture);

  // Removes the listener for the given file update event
  // the listener will stop receiving notifications after this call.
  void removeEventListener(DOMString type, EventListener listener);

  // Sends an event to the event listeners the same as if it was delivered directly.
  boolean dispatchEvent(DeviceStorageChangeEvent event);

  // See interface below for how to use this
  DeviceStorageCursor enumerate(optional DOMString directory)
  DeviceStorageCursor enumerateEditable(optional DOMString directory)
};

interface DeviceStorageCursor : DOMRequest {
  // .result is either a File or a FileHandle
  
  void continue();
};

interface DeviceStorageChangeEvent : Event{
  //.type is "devicestoragechange"
  //.target is the DeviceStorage object that caused this
  DOMString change; //one of "created","modified", or "deleted"
  DOMString path; //absolute path to the file that updated
}