Classes

An Entry represents a typed collection of data in Contentful

A Space represents a collection of Content Types, Assets and Entries in Contentful

Undocumented

A Content Type represents your data model for Entries in a Contentful Space

An asset represents a media file in Contentful

Client object for performing requests against the Contentful API.

A container for the synchronized state of a Space

Protocol for resources inside Contentful

LocalizableResource

Base class for any Resource that has the capability of carrying information for multiple locales. If more than one locale is fetched using either /sync endpoint, or specifying the wildcard value for the locale paramater (i.e [locale: *]) during a fetch, the SDK will cache returned values for all locales. This class gives an interface to specify which locale should be used when fetching data from Resource instances that are in memory.

A Locale represents possible translations for Entry Fields

The LocalizationContext contains meta information about a Space about locales including information about which locale is the default, and what the fallback locale chain is.

This contextual information is necessary to intiialize Entry and Asset instances properly so that the correct data is displayed for the currently selected locale. For instance, if a particular field for an Entry does not have data for the currently selected locale, the SDK will walk the fallback chain for this field until a non-null value is found, or full chain has been walked.

A concrete implementation of ChainableQuery which can be used to make queries on either /assets/ or /entries. All methods from ChainableQuery are available.

Queries on Asset types. All methods from Query, and therefore ChainableQuery, are inherited and available.

An additional query to filter by the properties of linked objects when searching on references. See: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/search-on-references and see the init(whereLinkAt fieldNameForLink: String, matches filterQuery: FilterQuery? = nil) methods on QueryOn for example usage.

A concrete implementation of AbstractQuery which requires that a model class conforming to EntryType be passed in as a generic parameter.

The content_type parameter of the query will be set to the contentTypeID of your EntryType conforming model class. QueryOn<EntryType> are chainable so complex queries can be constructed. Operations that are only available when querying Entrys on specific content types (i.e. content_type must be set) are available through this class.

Information regarding an error received from Contentful

For requests that do hit the Contentful Delivery API enforces rate limits of 78 requests per second and 280800 requests per hour by default. Higher rate limits may apply depending on your current plan.

Undocumented