urlscheme.js
1.82 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
/*
*
* 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 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.
*/
/* globals Promise */
define('screens/player/firmware/preferences/spi/urlscheme', [], function() {
'use strict';
/**
* Defines the preferences storage service provider interface.
*
* @interface URLScheme
*/
return Object.freeze({
serviceName: 'com.adobe.cq.screens.player.preferences.spi.urlscheme',
/**
* Generates a schemed url based on the given preferences
* @memberof URLScheme
* @param {Object} preferences The preferences to be included in the URL
* @return {Promise} A promise that resolves to the generated URL.
*/
generateURL: function() {
return Promise.reject();
},
/**
* Registers a listener that is called when the url handling is triggered.
* If the handling already happened, the listener is called immediately.
* @memberof URLScheme
* @param {function} listener The listener to register
*/
on: function(listener) {},
/**
* Unregister an alreadt register listener.
* @param {function} listener The listener to unregister
* @memberof URLScheme
*/
off: function(listener) {}
});
});