Consent resource

ConsentKindResourceCopy Anchor Link

class ConsentKindResource

One kind of consent the signed-in user gives or withdraws.

Reached through ovok.consent.legal and ovok.consent.medical.

ConstructorsCopy Anchor Link

ConsentKindResource.newCopy Anchor Link

ConsentKindResource(
  HttpClient _http,
  String _path,
  String _acceptedField,
)

Built by Ovok; use ovok.consent.legal or ovok.consent.medical instead.

MethodsCopy Anchor Link

ConsentKindResource.retrieveCopy Anchor Link

Future<Map<String, dynamic>> retrieve()

Retrieves the consent. Calls GET v1/me/consent/{kind}.

Returns Future<Map<String, dynamic>>.

ConsentKindResource.setCopy Anchor Link

Future<Map<String, dynamic>> set({required bool accepted})

Gives the consent, or withdraws it when accepted is false.

Calls POST v1/me/consent/{kind}.

Returns Future<Map<String, dynamic>>.

ConsentResourceCopy Anchor Link

class ConsentResource

The signed-in user's consents. Reached through ovok.consent.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

ConsentResource.newCopy Anchor Link

ConsentResource(HttpClient _http)

Built by Ovok; use ovok.consent instead.

PropertiesCopy Anchor Link

ConsentResource.legalCopy Anchor Link

final ConsentKindResource legal

Consent to the terms and conditions, at v1/me/consent/legal.

ConsentResource.medicalCopy Anchor Link

final ConsentKindResource medical

Consent to medical settings notifications, at v1/me/consent/medical.

MethodsCopy Anchor Link

ConsentResource.requestSignatureCopy Anchor Link

Future<Map<String, dynamic>> requestSignature(String consentId)

Requests a signature for the consent consentId.

Calls POST consent/signature/{consentId}.

Returns Future<Map<String, dynamic>>.