Home > @vsf-enterprise/sapcc > UseConsentsComposable
UseConsentsComposable interface
Composable method allowing to fetch & manage consents
Signature:
export interface UseConsentsComposable
Properties
| Property | Type | Description |
|---|---|---|
| consents | ComputedProperty<ConsentTemplateList> | A list of Consent Templates |
| error | ComputedProperty<UseConsentsError> | An indicator of useConsents composable methods errors |
| giveAllConsents | () => Promise<void> | A method allowing to give all consents |
| giveConsent | (props: GiveConsentProps) => Promise<void> | A method allowing to give a consent |
| isAccepted | (template: ConsentTemplate) => boolean | A helper returning the state of consent |
| load | (props?: LoadConsentsProps) => Promise<void> | A method allowing to fetch consent templates |
| loading | ComputedProperty<UseConsentsLoading> | An indicator of useConsents composable methods progress |
| mergeAnonymousConsents | () => Promise<void> | A method allowing to merge anonymous user's consents with authenticated user's consents |
| removeConsent | (props: RemoveConsentProps) => Promise<void> | A method allowing to remove a consent |