update.js 2.58 KB
/*
 * ADOBE CONFIDENTIAL
 *
 * Copyright 2016 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 */
/* istanbul ignore next */
/* globals Promise */

define('screens/player/firmware/update/spi/update', [], function() {
    'use strict';

    /**
     * Defines the preferences API.
     *
     * @interface DeviceStorage
     */
    return Object.freeze({

        /**
         * The service name
         * @property serviceName
         * @memberof DeviceStorage
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.update.spi.update',

        /**
         * Returns a promise that resolves when the ContentSync Backend is ready.
         * @memberof DeviceStorage
         * @returns {Promise} Undefined
         */
        start: function() {
            return Promise.resolve();
        },


        /**
         * Returns a promise that resolves with either ok or ok-new when an
         * Update is available.
         * @memberof DeviceStorage
         * @param  {Object} spec Spec for the request
         * @returns {Promise} String ok || ok-now
         */
        checkForUpdates: function(spec) {
            return Promise.resolve();
        },

        /**
         * Returns a promise that resolves when new Software is downloaded.
         * @memberof DeviceStorage
         * @param  {Object} spec Spec for the request
         * @returns {Promise} Undefined
         */
        download: function(spec) {
            return Promise.resolve();
        },

        /**
         * Returns a promise that resolves when software is installed.
         * @memberof DeviceStorage
         * @param  {Object} spec Spec for the request
         * @returns {Promise} Undefined
         */
        install: function(spec) {
            return Promise.resolve();
        },

        /**
         * Indicates if the Update can be done step-by-step.
         * @memberof DeviceStorage
         * @returns {Boolean} true or false
         */
        hasStepByStepSupport: function() {
            return false;
        }

    });

});