serviceadmin.service.js 1.79 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.
 */

/* eslint strict: 0, no-unused-vars: 0 */

/**
 * Defines the service interface used by the {@link ServiceAdmin}.
 * Note: that this file serves pure documentation purposes and is not used in the code yet.
 *
 * @interface module:screens/player/shared/serviceadmin.Service
 */
var Service = {

    /**
     * Name(s) of the service
     * @memberof module:screens/player/shared/serviceadmin.Service
     * @type {Array|String}
     */
    serviceName: null,

    /**
     * Service Ranking. Higher is better.
     * @memberof module:screens/player/shared/serviceadmin.Service
     * @type {Number}
     */
    serviceRanking: 0,

    /**
     * Activate method.
     * @memberof module:screens/player/shared/serviceadmin.Service
     * @returns {*|Promise} Optional a promise that resolves (or rejects) when completed.
     */
    activate: function() {
        return Promise.resolve();
    },

    /**
     * Deactivate method.
     * @memberof module:screens/player/shared/serviceadmin.Service
     * @returns {*|Promise} Optional a promise that resolves (or rejects) when completed.
     */
    deactivate: function() {
        return Promise.resolve();
    }
};