chrome/common/extensions/api/experimental_system_info_storage.idl

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 namespace experimental.systemInfo.storage {
   6
   7   enum StorageUnitType {
   8     // Unknow storage type.
   9     unknown,
  10     // Hard disk.
  11     harddisk,
  12     // Removable storage, e.g.USB device.
  13     removable
  14   };
  15
  16   dictionary StorageUnitInfo {
  17     // The unique id of the storage unit.
  18     DOMString id;
  19     // The type of storage device. The value is one of the constants defined
  20     // for this type.
  21     StorageUnitType type;
  22     // The total amount of the storage space, in bytes.
  23     double capacity;
  24     // The available amount of the storage space, in bytes.
  25     double availableCapacity;
  26   };
  27
  28   dictionary StorageChangeInfo {
  29     // The uniue id of the storage unit already changed.
  30     DOMString id;
  31     // The new value of the available capacity.
  32     double availableCapacity;
  33   };
  34
  35   callback StorageInfoCallback = void (StorageUnitInfo[] info);
  36
  37   interface Functions {
  38     // Get the storage information from the system. The argument passed to the
  39     // callback is an array of StorageUnitInfo objects.
  40     static void get(StorageInfoCallback callback);
  41   };
  42
  43   interface Events {
  44     // Fired when the storage information is updated.
  45     // |info|   : The changed information for the specified storage unit
  46     static void onAvailableCapacityChanged(StorageChangeInfo info);
  47   };
  48
  49 };
  50