CMS resource

CmsDocumentsResourceCopy Anchor Link

class CmsDocumentsResource

Published documents of any CMS collection. Reached through ovok.cms.documents.

locale takes an app language ("de-DE") or a CMS locale ("de"); an unsupported language reads as "en".

ConstructorsCopy Anchor Link

CmsDocumentsResource.newCopy Anchor Link

CmsDocumentsResource(HttpClient http, String tenantCode)

Built by Ovok; use ovok.cms.documents instead.

MethodsCopy Anchor Link

CmsDocumentsResource.listCopy Anchor Link

Future<Page<JsonMap>> list(String collection, [QueryParams params = const {}])

Lists the published documents of collection.

Calls GET v1/public/cms/collections/{collection}/items. params takes locale, page, limit and sort.

Returns Future<Page<Map<String, dynamic>>>.

CmsDocumentsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(
  String collection,
  String slug, [
  QueryParams params = const {},
])

Retrieves the document slug of collection.

Calls GET v1/public/cms/collections/{collection}/items/{slug}. Throws OvokValidationException when slug is empty.

Returns Future<Map<String, dynamic>>.

CmsReleaseNotesResourceCopy Anchor Link

class CmsReleaseNotesResource

Published release notes. Reached through ovok.cms.releaseNotes.

ConstructorsCopy Anchor Link

CmsReleaseNotesResource.newCopy Anchor Link

CmsReleaseNotesResource(HttpClient http, String tenantCode)

Built by Ovok; use ovok.cms.releaseNotes instead.

MethodsCopy Anchor Link

CmsReleaseNotesResource.listCopy Anchor Link

Future<Page<JsonMap>> list([QueryParams params = const {}])

Lists the release-notes collection, sorted by -publishedAt unless params names a sort.

Returns Future<Page<Map<String, dynamic>>>.

CmsResourceCopy Anchor Link

class CmsResource

Published CMS documents, legal pages and translations. Reached through ovok.cms.

Reads go to v1/public/cms/collections, always as the client's tenant, so they work before sign-in.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

CmsResource.newCopy Anchor Link

CmsResource(HttpClient http, String tenantCode)

Built by Ovok; use ovok.cms instead.

PropertiesCopy Anchor Link

CmsResource.documentsCopy Anchor Link

final CmsDocumentsResource documents

Published documents of any collection.

CmsResource.releaseNotesCopy Anchor Link

final CmsReleaseNotesResource releaseNotes

Published release notes, newest first.

MethodsCopy Anchor Link

CmsResource.legalPageCopy Anchor Link

Future<JsonMap> legalPage(String slug, [QueryParams params = const {}])

Retrieves a legal page by slug, such as "terms-and-conditions" or "data-privacy".

Reads the legal-pages collection; readable before sign-in.

Returns Future<Map<String, dynamic>>.

CmsResource.translationsCopy Anchor Link

Future<JsonMap> translations([String? locale])

Retrieves the translations collection as one tree, readable before sign-in.

Each document's slug is a group holding each row's value at its key, nested at the dots; the first row wins. Reads at most 20 pages of 50. Nothing is kept on the device.

Returns Future<Map<String, dynamic>>.