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

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

        /**
         * The service name
         * @property serviceName
         * @memberof Cache
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.cache.cache',

        /**
         * The service namespace
         * @property cache
         * @memberof Cache
         * @constant
         */
        NAMESPACE: 'cache',

        /**
         * The service actions
         * @property ACTIONS
         * @memberof Cache
         * @constant
         */
        ACTIONS: Object.freeze({
            RESET_FIRMWARE: 'cache-reset-firmware',
            CLEAR_CHANNELS_DATA: 'cache-clear-channelsData',
            CLEAR_APP_CACHE: 'cache-clear-appCache',
            CLEAR_ALL: 'cache-clear-all',

            CLEAR_DONE: 'cache-clear-done'
        }),

        /**
         * Flags
         * @property FLAGS
         * @memberof Cache
         * @constant
         */
        FLAGS: Object.freeze({
            REBOOT_ON_COMPLETE: 'reboot-on-save'
        }),

        /**
         * Clears the firmware cache, and falls back to the factory defaults
         * @param {Object} [flags] Object containing Cache.FLAGS ({FLAG: true})
         * @function Cache#resetFirmware
         */
        resetFirmware: function(flags) {},

        /**
         * Clears the channels cache
         * @param {Object} [flags] Object containing Cache.FLAGS ({FLAG: true})
         * @function Cache#clearChannelsData
         */
        clearChannelsData: function(flags) {},

        /**
         * Clears the application cache
         * @param {Object} [flags] Object containing Cache.FLAGS ({FLAG: true})
         * @function Cache#clearAppCache
         */
        clearAppCache: function(flags) {},

        /**
         * Clears the channels and the app cache, and reset the Cache to the factory defaults
         * @param {Object} [flags] Object containing Cache.FLAGS ({FLAG: true})
         * @function Cache#clearAll
         */
        clearAll: function(flags) {}

    });

});