Content resource

ContentResourceCopy Anchor Link

class ContentResource

Project content items, by type, language and key. Reached through ovok.content.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

ContentResource.newCopy Anchor Link

ContentResource(HttpClient _http)

Built by Ovok; use ovok.content instead.

MethodsCopy Anchor Link

ContentResource.searchCopy Anchor Link

Future<JsonMap> search(
  String type,
  String language, [
  QueryParams params = const {},
])

Searches the type items in language.

Calls GET cms/{type}/{language} with params.

Returns Future<Map<String, dynamic>>.

ContentResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(
  String type,
  String language,
  String key,
)

Retrieves one item. Calls GET cms/{type}/{language}/{key}.

Returns Future<Map<String, dynamic>>.

ContentResource.createCopy Anchor Link

Future<JsonMap> create(
  String type,
  String language,
  JsonMap body,
)

Creates an item. Calls POST cms/{type}/{language}.

Returns Future<Map<String, dynamic>>.

ContentResource.updateCopy Anchor Link

Future<JsonMap> update(
  String type,
  String language,
  String key,
  JsonMap body,
)

Replaces one item. Calls PUT cms/{type}/{language}/{key}.

Returns Future<Map<String, dynamic>>.

ContentResource.deleteCopy Anchor Link

Future<void> delete(
  String type,
  String language,
  String key,
)

Deletes one item. Calls DELETE cms/{type}/{language}/{key}.

Returns Future<void>.

ContentResource.mapCopy Anchor Link

Future<JsonMap> map(
  String type,
  String language, [
  QueryParams params = const {},
])

Pairs each default-language item with its language translation.

Calls GET cms/{type}/map/{language} with params.

Returns Future<Map<String, dynamic>>.

ContentResource.copyFromParentCopy Anchor Link

Future<JsonMap> copyFromParent(
  String type,
  String language,
  String key,
)

Copies one item from the parent project.

Calls POST cms/{type}/{language}/{key}/copy-from-parent-project.

Returns Future<Map<String, dynamic>>.

ContentResource.copyAllFromParentCopy Anchor Link

Future<JsonMap> copyAllFromParent(String type, String language)

Copies every type item in language from the parent project.

Calls POST cms/{type}/{language}/copy-from-parent-project.

Returns Future<Map<String, dynamic>>.