update.js 3.21 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 */
define('screens/player/firmware/update/update', [], function() {
    'use strict';

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

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

        /**
         * The various update states.
         * @enum {Update.STATES}
         * @memberof Update
         * @readonly
         */
        STATES: Object.freeze({

            /**
             * Check for updates
             * @memberof Update.STATES
             */
            INITIALIZED: 'initialized',

            /**
             * Checking for updates.
             * @memberof Update.STATES
             */
            CHECKING: 'checking',

            /**
             * Updates available.
             * @memberof Update.STATES
             */
            HAS_UPDATES: 'has-updates',

            /**
             * Up to date. Check for updates.
             * @memberof Update.STATES
             */
            UP_TO_DATE: 'up-to-date',

            /**
             * Download updates.
             * @memberof Update.STATES
             */
            UPDATING: 'updating',

            /**
             * Updated.
             * @memberof Update.STATES
             */
            UPDATED: 'updated',

            /**
             * Installing.
             * @memberof Update.STATES
             */
            INSTALLING: 'installing',

            /**
             * Start.
             * @memberof Update.STATES
             */
            START: 'start',

            /**
             * Error.
             * @memberof Update.STATES
             */
            ERROR: 'error'
        }),

        /**
         * Namespace in the store
         * @property NAMESPACE
         * @memberof Update
         * @constant
         */
        NAMESPACE: 'updater',

        /**
         * Updates the Firmware.
         * @function Update#update
         */
        update: function() {},

        /**
         * Updates the Firmware step by step.
         * 1. Check for Updates, 2. Update, 3. Install, 4. Restart
         * @function Update#nextStep
         */
        nextStep: function() {},

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

});