filesystem.js
2.28 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
66
67
68
/*
*
* 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 */
/* globals Promise */
define('screens/player/firmware/filesystem/spi/filesystem', [], function() {
'use strict';
/**
* Defines the Filesystem SPI.
*
* @interface FilesystemSpi
*/
return Object.freeze({
/**
* The service name
* @property serviceName
* @memberof FilesystemSpi
* @constant
*/
serviceName: 'com.adobe.cq.screens.player.filesystem.spi.filesystem',
/**
* Joins all given path segments together using the platform specific separator as a delimiter,
* then normalizes the resulting path.
* Zero-length path segments are ignored. If the joined path string is a zero-length string then '.'
* will be returned, representing the current working directory.
*
* @function Filesystem#joinPath
* @param {Array} paths specific normalised path
* @return {String} Platform specific normalised path
*/
joinPath: function() { return new Error('not implemented'); },
/**
* Returns the root path where the offline file will be extracted.
* @function Filesystem#getUserDataPath
* @return {Promise} Path to User data folder
*/
getUserDataPath: function() { return Promise.reject('Not implemented.'); },
/**
* Returns the body of the given path as text.
* @param {String} path The path to the file
* @function Filesystem#readFileAsText
* @return {Promise} The body of the given file as text.
*/
readFileAsText: function(path) { return Promise.reject('Not implemented.'); }
});
});