Sensibill Core/com.getsensibill.core.apimodule.folders.api/FoldersDataProvider

FoldersDataProvider

interface FoldersDataProvider

Data provider containing the various requests used to manipulate Folders

Inheritors

Functions

Link copied to clipboard
abstract suspend fun addDocumentsToFolder(modifyContentsPayload: ModifyFolderContentsPayload): DataProviderResponse<ModifyFolderContentsResponse>
abstract suspend fun addDocumentsToFolder(folderId: String, documentIdsToAdd: List<String>): DataProviderResponse<ModifyFolderContentsResponse>

Add documents to a folder

Link copied to clipboard
abstract suspend fun createFolder(createPayload: CreateFolderPayload): DataProviderResponse<CreateFolderResponse>

Create a new folder for the user. Folders with duplicate names are not allowed.

Link copied to clipboard
abstract suspend fun deleteFolders(deletePayload: DeleteFolderPayload): DataProviderResponse<List<String>>
abstract suspend fun deleteFolders(vararg ids: String, deleteDocuments: Boolean = false): DataProviderResponse<List<String>>
abstract suspend fun deleteFolders(ids: List<String>, deleteDocuments: Boolean = false): DataProviderResponse<List<String>>

Delete one or more folders by id

Link copied to clipboard
abstract suspend fun getFolders(): DataProviderResponse<FolderList>

Fetch the user's list of folders

Link copied to clipboard
abstract suspend fun removeDocumentsFromFolder(modifyContentsPayload: ModifyFolderContentsPayload): DataProviderResponse<ModifyFolderContentsResponse>
abstract suspend fun removeDocumentsFromFolder(folderId: String, documentIdsToRemove: List<String>): DataProviderResponse<ModifyFolderContentsResponse>

Remove documents from a folder

Link copied to clipboard
abstract suspend fun updateFolder(updatePayload: UpdateFolderPayload): DataProviderResponse<Unit>

Update the display properties of a folder