files-api-frontend

Documentation / lib/components/Editor/storage/files-api-frontend

clearLocalStorage()

function clearLocalStorage(): void;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:234

Returns

void

---

createFile()

function createFile(
   file: any, 
   userId: any, 
   useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:109

Parameters

Parameter	Type	Default value
file	any	undefined
userId	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>

---

deleteFile()

function deleteFile(
   fileId: any, 
   userId: any, 
   useLocalStorage: boolean): Promise<{
  success: boolean;
}>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:132

Parameters

Parameter	Type	Default value
fileId	any	undefined
userId	any	undefined
useLocalStorage	boolean	true

Returns

Promise<{ success: boolean; }>

---

fetchData()

function fetchData(endpoint: any, useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:153

• BASE API FUNCTIONS

Parameters

Parameter	Type	Default value
endpoint	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>

---

fetchFromAPI()

function fetchFromAPI(endpoint: any): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:162

Parameters

Parameter	Type
endpoint	any

Returns

Promise<any>

---

getUserFileIndex()

function getUserFileIndex(userId: any, useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:74

Parameters

Parameter	Type	Default value
userId	any	undefined
useLocalStorage	boolean	false

Returns

Promise<any>

---

getUserSettings()

function getUserSettings(userId: any, useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:48

Parameters

Parameter	Type	Default value
userId	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>

---

removeFromLocalStorage()

function removeFromLocalStorage(key: any): void;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:230

Parameters

Parameter	Type
key	any

Returns

void

---

saveToLocalStorage()

function saveToLocalStorage(key: any, data: any): void;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:222

Parameters

Parameter	Type
key	any
data	any

Returns

void

---

updateFile()

function updateFile(
   fileId: any, 
   updates: any, 
   useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:26

Parameters

Parameter	Type	Default value
fileId	any	undefined
updates	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>

---

updateUserFileIndex()

function updateUserFileIndex(
   userId: any, 
   fileId: any, 
   action: any, 
   useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:83

Parameters

Parameter	Type	Default value
userId	any	undefined
fileId	any	undefined
action	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>

---

updateUserSettings()

function updateUserSettings(
   userId: any, 
   newSettings: any, 
   useLocalStorage: boolean): Promise<any>;

Defined in: web-app/src/lib/components/Editor/storage/files-api-frontend.js:57

Parameters

Parameter	Type	Default value
userId	any	undefined
newSettings	any	undefined
useLocalStorage	boolean	true

Returns

Promise<any>