Contentful SDK
Contentful SDK

View Source Contentful.Queryable behaviour (Contentful SDK v0.6.0)

Behaviour for allowing another module to be processed by the functions of Contentful.Query.

See also:

Link to this section Summary

Callbacks

endpoint()
resolve_collection_response(map)
resolve_entity_response(map)

Link to this section Callbacks

Link to this callback

endpoint()

View Source 
@callback endpoint() :: String.t()
Link to this callback

resolve_collection_response(map)

View Source 
@callback resolve_collection_response(%{
  required([{:total, String.t()}]) => non_neg_integer(),
  required([{:items, String.t()}]) => [...]
}) :: {:ok, [struct()], [{:total, non_neg_integer()}]}
Link to this callback

resolve_entity_response(map)

View Source 
@callback resolve_entity_response(map()) :: {:ok, struct()}