getFullFolderTree
Retrieves the full folder tree.
Copy FolderApi.getFullFolderTree(orderBy) -> List[Dict] Parameters
Copy orderBy: Specifies the ordering of the folders. Returns
Copy List of dictionaries representing the full folder tree. getHomeFolderTree
Retrieves the home folder tree.
Copy FolderApi.getHomeFolderTree(orderBy) -> Dict Parameters
Copy orderBy: Specifies the ordering of the folders. Returns
Copy Dictionary representing the home folder tree. getHomeSubFolderTree
Retrieves the subfolders of the home folder.
Copy FolderApi.getHomeSubFolderTree(orderBy) -> List[Dict] Parameters
Copy orderBy: Specifies the ordering of the folders. Returns
Copy List of dictionaries representing the subfolders of the home folder. getFolderAndFiles
Retrieves the contents of a folder including subfolders and files.
Copy FolderApi.getFolderAndFiles(folderId, orderBy, deleted) -> Dict Parameters
Copy folderId: The ID of the folder to retrieve contents from.
orderBy: Specifies the ordering of the contents.
deleted: Indicates whether to include deleted items. Returns
Copy Dictionary containing the folder and its files. getSubFolders
Retrieves the subfolders of a folder.
Copy FolderApi.getSubFolders(folderId, orderBy) -> Dict Parameters
Copy folderId: The ID of the folder to retrieve subfolders from.
orderBy: Specifies the ordering of the subfolders. Returns
Copy Dictionary containing the subfolders of the specified folder. getFolderParents
Retrieves the parent folders of a folder.
Copy FolderApi.getFolderParents(folderId) -> Dict Parameters
Copy folderId: The ID of the folder to retrieve parent folders for. Returns
Copy Dictionary containing the parent folders of the specified folder. getHomeFolderFiles
Retrieves the files in the home folder.
Copy FolderApi.getHomeFolderFiles(orderBy) -> Dict Parameters
Copy orderBy: Specifies the ordering of the files. Returns
Copy Dictionary containing the files in the home folder. getFolderTask
Retrieves the task associated with a folder.
Copy FolderApi.getFolderTask(folderId) -> Dict Parameters
Copy folderId: The ID of the folder to retrieve the task for. Returns
Copy Dictionary containing the task associated with the folder. createFolder
Creates a new folder.
Copy FolderApi.createFolder(folder) -> Dict Parameters
Copy folder: Dictionary representing the folder to be created. Returns
Copy Dictionary containing the result of the folder creation operation. updateFolder
Updates an existing folder.
Copy FolderApi.updateFolder(folder) -> Dict Parameters
Copy folder: Dictionary representing the folder to be updated. Returns
Copy Dictionary containing the result of the folder update operation. renameFolder
Renames a folder.
Copy FolderApi.renameFolder(folderId, newName) -> Dict Parameters
Copy folderId: The ID of the folder to be renamed.
newName: The new name for the folder. Returns
Copy Dictionary containing the result of the folder rename operation. moveFolder
Moves a folder to a new parent folder.
Copy FolderApi.moveFolder(folderId, newParentId) -> Dict Parameters
Copy folderId: The ID of the folder to be moved.
newParentId: The ID of the new parent folder. Returns
Copy Dictionary containing the result of the folder move operation. deleteFolder
Deletes a folder.
Copy FolderApi.deleteFolder(folderId) -> Dict Parameters
Copy folderId: The ID of the folder to be deleted. Returns
Copy Dictionary containing the result of the folder deletion operation. deleteGroup
Deletes a group.
Copy FolderApi.deleteGroup(groupId) -> Dict Parameters
Copy groupId: The ID of the group to be deleted. Returns
Copy Dictionary containing the result of the group deletion operation. createUploadSignedUrl
Creates a signed URL for uploading files to a folder.
Copy FolderApi.createUploadSignedUrl(folderId, duration=None) -> Dict Parameters
Copy folderId: The ID of the folder where files will be uploaded.
duration: The duration for which the signed URL is valid (optional). Returns
Copy Dictionary containing the signed URL for uploading files. createDownloadSignedUrl
Creates a signed URL for downloading files.
Copy FolderApi.createDownloadSignedUrl(id, baseUri=None, duration=None) -> Dict Parameters
Copy id: The ID of the file to be downloaded.
baseUri: The base URI for downloading the file (optional).
duration: The duration for which the signed URL is valid (optional). Returns
Copy Dictionary containing the signed URL for downloading files. renameFile
Renames a file.
Copy FolderApi.renameFile(fileId, newName) -> Dict Parameters
Copy fileId: The ID of the file to be renamed.
newName: The new name for the file. Returns
Copy Dictionary containing the result of the file rename operation. moveFile
Moves a file to a new parent folder.
Copy FolderApi.moveFile(fileId, newParentFolderId) -> Dict Parameters
Copy fileId: The ID of the file to be moved.
newParentFolderId: The ID of the new parent folder. Returns
Copy Dictionary containing the result of the file move operation. deleteFile
Deletes a file.
Copy FolderApi.deleteFile(fileId) -> Dict Parameters
Copy fileId: The ID of the file to be deleted. Returns
Copy Dictionary containing the result of the file deletion operation. deleteFile2
Deletes a file with additional folder name.
Copy FolderApi.deleteFile2(fileId, folderName) -> Dict Parameters
Copy fileId: The ID of the file to be deleted.
folderName: The name of the folder containing the file. Returns
Copy Dictionary containing the result of the file deletion operation. deleteManyFiles
Deletes multiple files.
Copy FolderApi.deleteManyFiles(ids) -> Dict Parameters
Copy ids: List of IDs of files to be deleted. Returns
Copy Dictionary containing the result of the file deletion operation. restoreManyFiles
Restores multiple files from the trash.
Copy FolderApi.restoreManyFiles(ids, keepId) -> Dict Parameters
Copy ids: List of IDs of files to be restored.
keepId: Indicates whether to keep the original IDs.
Returns
Copy Dictionary containing the result of the file restoration operation. copyFile
Copies a file to a new location.
Copy FolderApi.copyFile(fileId, newParentFolderId, newName) -> Dict Parameters
Copy fileId: The ID of the file to be copied.
newParentFolderId: The ID of the destination folder.
newName: The new name for the copied file. Returns
Copy Dictionary containing the result of the file copy operation. shareFile
Shares a file with a user.
Copy FolderApi.shareFile(fileId, targetFolderPath, idOfUserToShareWith) -> Dict Parameters
Copy fileId: The ID of the file to be shared.
targetFolderPath: The path of the folder where the file will be shared.
idOfUserToShareWith: The ID of the user to share the file with. Returns
Copy Dictionary containing the result of the file sharing operation. assignFile
Assigns a file to a user.
Copy FolderApi.assignFile(fileId, idOfUserToAssign) -> Dict Parameters
Copy fileId: The ID of the file to be assigned.
idOfUserToAssign: The ID of the user to assign the file to. Returns
Copy Dictionary containing the result of the file assignment operation. updateStatus
Updates the status of a file.
Copy FolderApi.updateStatus(fileId, status) -> Dict Parameters
Copy fileId: The ID of the file to update the status for.
status: The new status of the file. Returns
Copy Dictionary containing the result of the status update operation. saveFileObject
Saves a file object.
Copy FolderApi.saveFileObject(params) -> Dict Parameters
Copy params: Parameters to save the file object. Returns
Copy Dictionary containing the result of the file object saving operation. saveFileObjectWithTask
Saves a file object with a task.
Copy FolderApi.saveFileObjectWithTask(params) -> Dict Parameters
Copy params: Parameters to save the file object with task. Returns
Copy Dictionary containing the result of the file object saving operation with task. saveFileObjectWithFunction
Saves a file object with a function.
Copy FolderApi.saveFileObjectWithFunction(params) -> Dict Parameters
Copy params: Parameters to save the file object with function. Returns
Copy Dictionary containing the result of the file object saving operation with function. retrieveSignedUrl
Retrieves a signed URL for a file.
Copy FolderApi.retrieveSignedUrl(params) -> Dict Parameters
Copy params: Parameters to retrieve the signed URL. Returns
Copy Dictionary containing the signed URL for the file. saveFileGetSignedUrl
Saves a file and retrieves a signed URL.
Copy FolderApi.saveFileGetSignedUrl(params) -> Dict Parameters
Copy params: Parameters to save the file and retrieve the signed URL. Returns
Copy Dictionary containing the result of the file saving operation and the signed URL. retrieveSignedUrlPublic
Retrieves a signed URL for a public file.
Copy FolderApi.retrieveSignedUrlPublic(params) -> Dict Parameters
Copy params: Parameters to retrieve the signed URL for a public file. Returns
Copy Dictionary containing the signed URL for the public file. saveFolderTask
Saves a folder task.
Copy FolderApi.saveFolderTask(params) -> Dict Parameters
Copy params: Parameters to save the folder task. Returns
Copy Dictionary containing the result of the folder task saving operation. search
Searches for items based on provided parameters.
Copy FolderApi.search(params) -> Dict Parameters
Copy params: Parameters for the search operation. Returns
Copy Dictionary containing the search results. autoComplete
Provides auto-completion based on provided parameters.
Copy FolderApi.autoComplete(params) -> Dict Parameters
Copy params: Parameters for the auto-completion operation. Returns
Copy Dictionary containing the auto-completion results. isBusy
Checks if a provider is busy.
Copy FolderApi.isBusy(providerName) -> Dict Parameters
Copy providerName: The name of the provider to check. Returns
Copy Dictionary containing the result of the provider busy check. startFullSyncTask
Starts a full synchronization task for a provider.
Copy FolderApi.startFullSyncTask(providerName) -> Dict Parameters
Copy providerName: The name of the provider to start the full sync task for. Returns
Copy Dictionary containing the result of the full sync task start operation. syncFolder
Synchronizes a folder.
Copy FolderApi.syncFolder(folderId) -> Dict Parameters
Copy folderId: The ID of the folder to synchronize. Returns
Copy Dictionary containing the result of the folder synchronization operation. getCreateGroupFolderWithFiles
Retrieves or creates a group folder with files.
Copy FolderApi.getCreateGroupFolderWithFiles(path) -> Dict Parameters
Copy path: The path of the group folder. Returns
Copy Dictionary containing the result of the group folder retrieval or creation operation. retrieveManyUploadSignedUrls
Retrieves many signed URLs for uploading files.
Copy FolderApi.retrieveManyUploadSignedUrls(bucketName, folderName, subFolder, folderId, fileNames, contentType, duration, functionName, functionParams) -> Dict Parameters
Copy bucketName: The name of the bucket.
folderName: The name of the folder.
subFolder: The subfolder within the folder.
folderId: The ID of the folder.
fileNames: List of file names.
contentType: The content type of the files.
duration: The duration for which the signed URL is valid.
functionName: The name of the function.
functionParams: The parameters for the function.
Returns
Copy Dictionary containing the result of the signed URL retrieval operation. retrieveSignedUrl (multimethod)
Retrieves a signed URL for a file using different parameters.
Copy FolderApi.retrieveSignedUrl(fileId, bucketName, folderName, subFolder, folderId, fileName, contentType, method, asAttachment, duration, publicShare) -> Dict Parameters
Copy fileId: The ID of the file.
bucketName: The name of the bucket.
folderName: The name of the folder.
subFolder: The subfolder within the folder.
folderId: The ID of the folder.
fileName: The name of the file.
contentType: The content type of the file.
method: The method for retrieving the signed URL.
asAttachment: Indicates whether to treat the file as an attachment.
duration: The duration for which the signed URL is valid.
publicShare: Indicates whether the file is publicly shared. Returns
Copy Dictionary containing the signed URL for the file. 