Classes

An asset represents a media file in Contentful.

Client object for performing requests against the Contentful Delivery and Preview APIs.

A ContentType represents your content model for entries in a Contentful space.

An Entry represents a typed collection of content, structured via fields, in Contentful.

Information regarding an error received from Contentful’s API.

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.

A Locale represents possible translations for Entry Fields

The LocalizationContext contains meta information about a Spaces 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.

Small class to store location coordinates. This is used in preferences over CoreLocation types to avoid extra linking requirements for the SDK.

A small class to create parameters used for ordering the responses when querying an endpoint that returns a colleciton of resources. See: ChainableQuery.order(by order: Ordering...)

A small class to create parameters used for ordering the responses when querying an endpoint that returns a collection of resources. This variation of an ordering takes a generic type parameter that conforms to ResourceQueryable in order to take advantage of the FieldKeys available on your type. See: ChainableQuery.order(by order: Ordering...)

A concrete implementation of AbstractResourceQuery which serves as the base class for both EntryQuery and AssetQuery.

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

Class to represent the information describing a resource that has been deleted from Contentful.

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 in moery. This class gives an interface to specify which locale should be used when reading content from Resource instances that are in memory.

The data describing the linked entry or asset for an EmbeddedResouceNode

BlockNode is the base class for all nodes which are rendered as a block (as opposed to an inline node).

InlineNode is the base class for all nodes which are rendered as an inline string (as opposed to a block node).

The top level node which contains all other nodes. @objc declaration, NSObject inheritance, and NSCoding conformance are required so RichTextDocument can be used as a transformable Core Data field.

Content contained in a table

Content contained in a table row

Content contained in a table row header cell

Content contained in a table row cell

A block of text, containing child Text nodes.

A block representing an unordered list containing list items as its children.

A block representing an ordered list containing list items as its children.

A block representing a block quote.

An item in either an ordered or unordered list.

A block representing a rule, or break within the content of the document.

A heading for the document.

A hyperlink with a title and URI.

A bblock containing data for a linked entry or asset.

A inline containing data for a linked entry or asset.

A Space represents a collection of content types, locales, assets, and entries in Contentful.

A container for the synchronized state of a Space

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 EntryQuery 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 using the contentTypeID of the generic parameter conforming to EntryDecodable. You must also implement ResourceQueryable in order to utilize these generic queries.

Queries on Asset types. All methods from ChainableQuery are available.

Queries on content types. All methods from ChainableQuery are available, are inherited and available.