Contentful SDK v0.3.2 API Reference
Modules
The Contentful SDK provides helper functions and structs for a subset of the the available Contentful APIs and serves as a container for the shared structs.
Represents an asset available within a Contentful.Space
.
Represents the fields of a Contentful.Asset
, which can very depending on the Contentful.Asset
.
Describes functions around ContentTypes in a Contentful.Space
Represents a single field in the field defintion of a Contentful.ContentType
.
The Delivery API is the main access point for fetching data for your customers. The API is read only.
Deals with the loading of assets from a given Contentful.Space
Provides functions around reading content types from a given Contentful.Space
Entries allows for querying the entries of a space via Contentful.Query
.
Handles the fetching of locales within a given Contentful.Space
Spaces provides function related to the reading of spaces through the Contentful Delivery API
An entry is a representation of anything that can be expressed as a
defined content type within a given Contentful.Space
.
The module provides functions to resolve the Entry <-> Asset relationships.
Represents a single locale available in a given Space - see
The Contentful Preview API allows the interaction with content that is not yet published and will return assets, entries, etc.
This module provides the chainable query syntax for building queries against the APIs of Contentful.
Behaviour for allowing another module to be processed by the functions
of Contentful.Query
.
A Space represents a space on contentful, holding most of the objects you work with, e.g. Contentful.Asset
, Contentful.Entry
or Contentful.Locale
This module extracts the stream functionality from the Contentful.Query
providing the underlying
functions for the streaming functionality of collectable entities from the Contentful API.
The SysData represents internal additional data for Contentful API objects, usually found in the "sys" part of the response objects. It's also referred to as "common properties".