reboot.js 2.07 KB
/*
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2017 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 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/reboot/reboot', [], function() {
    'use strict';

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

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

        /**
         * The service namespace in the store.
         * @memberof Reboot
         * @type {String}
         */
        NAMESPACE: 'reboot',

        /**
         * The various actions for this service
         * @memberof Reboot
         * @type {Map}
         */
        ACTIONS: {

            /**
             * Set the next reboot schedule
             * @type {String}
             */
            SET_NEXT: 'reboot-set-next'

        },

        /**
         * Schedules the device reboot based on the specified expression.
         * @function Reboot#schedule
         *
         * @param  {String} scheduleExpr The schedule expression
         *
         * @return {Promise} a promise that scheduling was successful
         */
        schedule: function(scheduleExpr) { return Promise.reject(); },

        /**
         * Clears the reboot schedule for the device.
         * @function Reboot#clear
         *
         * @return {Promise} a promise that scheduling was cleared
         */
        clear: function() { return Promise.reject(); }

    });

});