IUseCASharePointNotificationCenterConfig
@spartanfx/react / codeapps / IUseCASharePointNotificationCenterConfig
Interface: IUseCASharePointNotificationCenterConfig
Configuration for useCASharePointNotificationCenter.
Extends
Omit<ICANotificationCenterBaseConfig,"service">
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | - | Omit.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | - | Omit.cacheDuration |
choiceColumns? | string[] | SharePoint Choice / Lookup / Person column names that must be sent as the expanded reference object on create/update. Defaults to [schema.level] (typically ["Level"]) so the standard Level Choice column on the SharePoint Notifications list works without additional configuration. See: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/sharepoint-operations | Omit.choiceColumns | - |
debug? | boolean | Enable verbose console logging (default: false). | - | Omit.debug |
defaultToastDurationMs? | number | Default toast duration in ms (default: 4000). | - | Omit.defaultToastDurationMs |
maxItems? | number | Maximum items to load on initial fetch (default: 100). | - | Omit.maxItems |
onError? | (error) => void | Error callback. Called for every operational failure. | - | Omit.onError |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | - | Omit.onNotify |
onToast? | (item, durationMs) => void | Toast handler. Called when addNotification is invoked with mode toastOnly or toastAndList. Defaults to onNotify if provided; otherwise toast emission is skipped. | - | Omit.onToast |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | - | Omit.retryPolicy |
schema? | Partial<INotificationCenterSchema> | Schema mapping. Sensible defaults are applied when omitted — override only the columns the consumer's list renamed. | - | - |
service | ICATabularService<CANotificationRecord, string> | Generated SharePoint-list service produced by pac code add-data-source -a shared_sharepointonline -t <ListName> -d <siteUrl>. Typically located under src/generated/services/<ListName>Service.ts. | - | - |