IUseCASharePointTaskManagerConfig
@spartanfx/react / codeapps / IUseCASharePointTaskManagerConfig
Interface: IUseCASharePointTaskManagerConfig
Configuration for useCASharePointTaskManager.
Extends
Omit<ICATaskManagerBaseConfig<string>,"fieldMapping">
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | Omit.autoRefresh |
buckets? | string[] | Static list of status buckets. Provide this when the data source has no introspection capability (Dataverse choice metadata is not available at runtime via generated services). | Omit.buckets |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | Omit.cacheDuration |
choiceColumns? | string[] | Advanced hint for SharePoint reference columns. By default the hook handles status and assignedTo from the field mapping automatically. See: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/sharepoint-operations | - |
debug? | boolean | Enable verbose console logging (default: false). | Omit.debug |
fieldMapping? | ITaskFieldMapping | SharePoint list field mapping. Defaults to the SharePoint Tasks list conventions (Title, Description, DueDate, AssignedTo, Status). | - |
odataFilter? | string | OData $filter expression applied to getAll. Empty string or undefined means no filter. | Omit.odataFilter |
office365UsersService? | unknown | Generated Office365UsersService connector service. When provided, the people-picker searches the directory via SearchUserV2 for richer, faster results, and only falls back to the SharePoint connector's getReferencedEntity when the directory search yields nothing. Add the connector with pac code add-data-source -a shared_office365users -c <connectionId>, which generates the service you pass here. The selected user's UPN/email is still resolved to the SharePoint person reference on write via getReferencedEntity. Example import { Office365UsersService } from './generated/services/Office365UsersService'; useCASharePointTaskManager({ service: TasksService as never, office365UsersService: Office365UsersService }); | - |
onError? | (error) => void | Error callback. Called for every operational failure. | Omit.onError |
onGetUserSuggestions? | (searchText) => Promise<IUserSuggestion[]> | Optional advanced people-picker override. Managed adapters provide a backend-native default when the generated service exposes enough user lookup information. | Omit.onGetUserSuggestions |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | Omit.onNotify |
orderColumn? | string | Order column name to sort by. Optional — when omitted, no $orderby is sent (the connector returns server-default order). | Omit.orderColumn |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | Omit.retryPolicy |
rowLimit? | number | Maximum records per fetch (default: 5000). | Omit.rowLimit |
service | ICATabularService<CATaskRecord, string> | Generated tabular service from pac code add-data-source. | Omit.service |