sync.js 1.67 KB
/*
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2017 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.
 */
/* istanbul ignore next */
define('screens/player/firmware/packagemanager/spi/sync', function() {
    'use strict';

    /**
     * Defines the Sync SPI.
     *
     * @interface SyncSpi
     */
    return Object.freeze({

        /**
         * The service name
         * @property serviceName
         * @memberof SyncSpi
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.packagemanager.spi.sync',

        /**
         * Defines the copy strategy.
         */
        MODES: {
            MERGE: 'merge',
            REPLACE: 'replace'
        },

        /**
         * Update the specified package.
         * @memberof SyncSpi
         *
         * @param {String} url The url to the update package
         * @param {String} path The target path
         * @param {String} mode Defines the copy strategy
         * @param {function} onProgress the progress callback
         *
         * @return {Promise} A Promise that teh content was synced
         */
        sync: function(url, path, mode, onProgress) { return Promise.reject(); }

    });

});