Source: lib/offline/i_storage_engine.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  18. goog.provide('shaka.offline.IStorageEngine');
  20. goog.require('shaka.util.IDestroyable');
  24. /**
  25.  * An interface to abstract away the type of storage used on a specific
  26.  * platform.
  27.  *
  28.  * @interface
  29.  * @extends {shaka.util.IDestroyable}
  30.  */
  31. shaka.offline.IStorageEngine = function() {};
  34. /**
  35.  * Gets whether the storage engine is initialized.
  36.  *
  37.  * @return {boolean}
  38.  */
  39. shaka.offline.IStorageEngine.prototype.initialized;
  42. /**
  43.  * Initializes the storage system and creates the required tables.
  44.  *
  45.  * If opt_retryCount is given, then we are creating a new database and expect
  46.  * an 'upgradeneeded' event.  If we don't get one, we will retry opt_retryCount
  47.  * times.  This is used to work around a bug in IE/Edge and is only used in
  48.  * our unit tests.
  49.  *
  50.  * @see https://goo.gl/hOYJvN
  51.  *
  52.  * @param {!Object.<string, string>} storeMap
  53.  *   A map of store name to the key path.
  54.  * @param {number=} opt_retryCount
  55.  * @return {!Promise}
  56.  */
  57. shaka.offline.IStorageEngine.prototype.init;
  60. /**
  61.  * Gets the item with the given ID in the store.
  62.  *
  63.  * @param {string} storeName
  64.  * @param {number} key
  65.  * @return {!Promise.<T>}
  66.  * @template T
  67.  */
  68. shaka.offline.IStorageEngine.prototype.get;
  71. /**
  72.  * Calls the given callback for each value in the store. The promise will
  73.  * resolve after all items have been traversed.
  74.  *
  75.  * @param {string} storeName
  76.  * @param {function(T)} callback
  77.  * @return {!Promise}
  78.  * @template T
  79.  */
  80. shaka.offline.IStorageEngine.prototype.forEach;
  83. /**
  84.  * Adds or updates the given value in the store.
  85.  *
  86.  * @param {string} storeName
  87.  * @param {!Object} value
  88.  * @return {!Promise}
  89.  */
  90. shaka.offline.IStorageEngine.prototype.insert;
  93. /**
  94.  * Removes the item with the given key.
  95.  *
  96.  * @param {string} storeName
  97.  * @param {number} key
  98.  * @return {!Promise}
  99.  */
  100. shaka.offline.IStorageEngine.prototype.remove;
  103. /**
  104.  * Removes the elements with the given keys.
  105.  *
  106.  * @param {string} storeName
  107.  * @param {!Array<number>} keys
  108.  * @param {function()=} opt_onKeyRemoved
  109.  * @return {!Promise}
  110.  */
  111. shaka.offline.IStorageEngine.prototype.removeKeys;
  114. /**
  115.  * Reserves the next ID and returns it.
  116.  *
  117.  * @param {string} storeName
  118.  * @return {number}
  119.  */
  120. shaka.offline.IStorageEngine.prototype.reserveId;