IUseCASharePointDocumentManagerConfig
@spartanfx/react / codeapps / IUseCASharePointDocumentManagerConfig
Interface: IUseCASharePointDocumentManagerConfig
Configuration for useCASharePointDocumentManager.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | ICAAdapterBaseConfig.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | ICAAdapterBaseConfig.cacheDuration |
debug? | boolean | Enable verbose console logging (default: false). | ICAAdapterBaseConfig.debug |
libraryName? | string | Display label for the library (used in the breadcrumb). | - |
onAfterUpload? | (file, item) => void | Promise<void> | Called after successful upload. | - |
onBeforeUpload? | (file) => Promise<boolean | void> | Called before upload; return false to cancel. | - |
onError? | (error) => void | Error callback. Called for every operational failure. | ICAAdapterBaseConfig.onError |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | ICAAdapterBaseConfig.onNotify |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | ICAAdapterBaseConfig.retryPolicy |
rootFolderPath | string | Server-relative root folder path for the document library (e.g. /sites/contoso/Shared Documents). Used as the initial currentPath and for breadcrumb resolution. | - |
service | ICASharePointDocumentService | Consumer-provided connector adapter implementing the semantic API the hook needs. See createSharePointDocumentServiceFromConnector() for a reference bridge from the generated SharePoint connector service to this interface. | - |