Protocols

A simple protocol to bridge Contentful.Asset and other formats for storing asset information.

Classes conforming to this protocol can be decoded during JSON deserialization as reprsentations of Contentful assets.

The Integration protocol describes the libary name and version number for external integrations to be used in conjunction with the contentful.swift SDK.

Implement this protocol in order to provide your own custom logger for the SDK to log messages to. Your CustomLogger instance will only be passed message it should log according the set log level.

Classes conforming to this protocol can be passed into your Client instance so that fetch methods returning may decode the JSON to your own classes before returning them in async callbacks.

It’s important to note that there is no special handling of locales so if using the locale=* query parameter, you will need to implement the special handing in your init(from decoder: Decoder) throws initializer for your class.

Example:

func fetchArray(of: Cat.self, matching: QueryON<Cat>,
then completion: @escaping ResultsHandler<MappedArrayResponse<Cat>>) -> URLSessionDataTask?

Classes conforming to this protocol are accessible via an Endpoint.

Conform to this protocol and initialize your Client instance with the persistenceIntegration initialization parameter set to recieve messages about creation and deletion of Entrys and Assets in your space when doing sync operations using the Client.initialSync() and Client.nextSync()methods. Proper conformance to this protocol should enable persisting the state changes that happen in your Contentful space to a persistent store such asCoreData`.

Use types that conform to QueryableRange to perform queries with the four Range operators See: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/ranges

A base abtract type which holds the bare essentials shared by all query types in the SDK which enable querying against content types, entries and assets.

Protocol which enables concrete query implementations to be ‘chained’ together so that results can be filtered by more than one Query.Operation or other query. Protocol extensions give default implementation so that all concrete types, Query, AssetQuery, FilterQuery, and QueryOn<EntryType>, can use the same implementation.

A base abtract type which holds methods and constructors for all valid queries against resource: i.e. Contentful entries and assets.

The base abstract type for querying Contentful entries. The contained operations in the default implementation of this protocol can only be used when querying against the `/entries/ endpoint of the Content Delivery and Content Preview APIs. See: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters

Protocol for resources inside Contentful.

A protocol signifying that a resource’s Sys property are accessible for lookup from the top level of the instance.

A protocol enabling strongly typed queries to the Contentful Delivery API via the SDK.

Entities conforming to this protocol have a QueryType that the SDK can use to make generic fetch requests.

The base protocol which all node types that may be present in a tree of Structured text. See: https://www.contentful.com/developers/docs/tutorials/general/structured-text-field-type-alpha/ for more information.

Undocumented