IUseCASharePointPlannerConfig
@spartanfx/react / codeapps / IUseCASharePointPlannerConfig
Interface: IUseCASharePointPlannerConfig
Configuration for useCASharePointPlanner.
Note: the Power Apps SharePoint connector normalizes SharePoint list-item
numeric IDs to strings at the generated-service boundary — so the
connector service exposes get(id: string), update(id: string, ...),
delete(id: string) even though the underlying SP IDs are integers.
This config therefore uses string IDs to match.
Extends
ICAPlannerBaseConfig<string>
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | - | ICAPlannerBaseConfig.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | - | ICAPlannerBaseConfig.cacheDuration |
choiceColumns? | string[] | SharePoint Choice / Lookup / Person column names that must be sent as the expanded reference object on create/update. The hook calls service.getReferencedEntity for each column and substitutes the matching option object before posting the payload. No default — the Planner schema is consumer-driven, so declare here any groupField / colorField / custom columns that map to a SharePoint Choice (or Lookup / Person) column. Example choiceColumns: ['Department', 'Priority'] See: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/sharepoint-operations | ICAPlannerBaseConfig.choiceColumns | - |
debounceMs? | number | Debounce delay for refetch on date-range change (default: 300 ms). | - | ICAPlannerBaseConfig.debounceMs |
debug? | boolean | Enable verbose console logging (default: false). | - | ICAPlannerBaseConfig.debug |
endDate? | Date | Initial end of the visible range. Default: Dec 31 of current year. | - | ICAPlannerBaseConfig.endDate |
odataFilter? | string | Additional OData $filter to combine with the date-range clause. | - | ICAPlannerBaseConfig.odataFilter |
onError? | (error) => void | Error callback. Called for every operational failure. | - | ICAPlannerBaseConfig.onError |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | - | ICAPlannerBaseConfig.onNotify |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | - | ICAPlannerBaseConfig.retryPolicy |
rowLimit? | number | Maximum records per fetch (default: 5000). | - | ICAPlannerBaseConfig.rowLimit |
schema | IPlannerSchema | Schema mapping internal planner fields to data source columns. | - | ICAPlannerBaseConfig.schema |
searchText? | string | Optional search text for client-side filtering. | - | ICAPlannerBaseConfig.searchText |
service | ICATabularService<CAPlannerRecord, string> | Generated tabular service from pac code add-data-source. | - | ICAPlannerBaseConfig.service |
startDate? | Date | Initial start of the visible range. Default: Jan 1 of current year. | - | ICAPlannerBaseConfig.startDate |