command.js
2.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
* 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/command/command', [], function() {
'use strict';
/**
* Defines the command API.
*
* @interface PlayerCommand
*/
return Object.freeze({
/**
* The service name
* @property serviceName
* @memberof PlayerCommand
* @constant
*/
serviceName: 'com.adobe.cq.screens.player.command.command',
/**
* Checks is the command is supported by the handler.
* @memberof PlayerCommand
*
* @param {String} cmd The command to check
*
* @returns {Boolean} `true` if the command is supported, `false` otherwise
*/
canHandle: function(cmd) {
return false;
},
/**
* Handles a command. Function must be called with a valid Command.
* Doing otherwise will result in undefined behavior. Call `canHandle` first.
*
* @memberof PlayerCommand
*
* @param {String} command The command to execute.
* @param {Object} payload The command payload.
* @return {Promise|undefined} Returns a Promise if command is async.
* @throws Will throw an error if the Command cannot be handled unexpectedly.
*/
handleCommand: function(command, payload) {
return Promise.resolve();
}
});
});