Skip to main content

IUseCASharePointDocumentManagerReturn

@spartanfx/react v1.2.2


@spartanfx/react / codeapps / IUseCASharePointDocumentManagerReturn

Interface: IUseCASharePointDocumentManagerReturn

Return type for useCASharePointDocumentManager. Matches the existing SPFx adapter shape so the existing DocumentManager component consumes either result.

Properties

Required

PropertyTypeDescription
clearCache() => void-
createFolder(folderName, path?) => Promise<void>-
currentPathstring-
deleteItems(items) => Promise<void>-
documentManagerPropsIDocumentManagerPropsComponent-ready props for <DocumentManager {...documentManagerProps} />.
downloadItem(item) => Promise<void>-
duplicateItem(item) => Promise<void>-
errorError-
getShareLink(item) => Promise<string>-
itemsIDocumentItem[]-
loadingboolean-
moveItems(items, targetPath) => Promise<void>-
navigateToPath(path) => void-
onFolderOpen(folder) => void-
onNavigate(path) => void-
refresh() => Promise<void>-
renameItem(item, newName) => Promise<void>-
rootPathstring-
uploadFiles(files, path?) => Promise<void>-
uploadProgressICAUploadProgress[]-

Events & callbacks

PropertyTypeDescription
onCreateFolder?(folderName, targetPath) => Promise<void>-
onDelete?(items) => Promise<void>-
onDownload?(item) => Promise<void>-
onDuplicate?(item) => Promise<void>-
onMove?(items, targetPath) => Promise<void>-
onRename?(item, newName) => Promise<void>-
onUpload?(files, targetPath) => Promise<void>Component callback aliases. Undefined when the generated service cannot support the operation.