admin.js 1.9 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/runtime/admin', [], function() {
    'use strict';

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

        /**
         * The service name
         * @property serviceName
         * @memberof Admin
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.runtime.admin',

        /**
         * Possible actions on the service
         * @property ACTIONS
         * @memberof Admin
         * @constant
         * @type {Object}
         */
        ACTIONS: Object.freeze({
            SHOW: 'adminui-show',
            HIDE: 'adminui-hide'
        }),

        /**
         * The service namespace in the store.
         * @property NAMESPACE
         * @memberof Admin
         * @constant
         * @type {string}
         */
        NAMESPACE: 'adminui',

        /**
         * Triggers an action to show the admin ui
         * @param {string} [tabName] pass tab name to show dedicated tab
         * @function Admin#show
         */
        show: function(tabName) {
        },

        /**
         * Triggers an action to hide the admin ui
         * @function Admin#hide
         */
        hide: function() {
        }
    });

});