command-handler.js 1.47 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/command/command-handler', [], function() {
    'use strict';

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

        /**
         * The service name
         * @property serviceName
         * @memberof CommandHandler
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.command.handler',

        /**
         * Function follows the Redux Thunk Action Pattern.
         * It asks all available CommandHandlers to handle a command.
         * @memberof CommandHandler
         *
         * @param {String} command The command to execute.
         * @param {Object} payload The command payload.
         */
        handleCommand: function(command, payload) {}

    });

});