Client Class Reference

persistenceIntegration
The persistence integration which will receive delegate messages from the Client when new Entry and Asset objects are created from data being sent over the network. Currently, these messages are only sent for client.initialSync() and client.nextSync. The relevant persistence integration lives at https://github.com/contentful/contentful-persistence.swift.
Declaration
Swift

public var persistenceIntegration: PersistenceIntegration?
Show on GitHub


                    
                    
                    init(spaceId:accessToken:clientConfiguration:sessionConfiguration:persistenceIntegration:contentModel:)

Initializes a new Contentful client instance

Declaration

Swift

public init(spaceId: String,
                accessToken: String,
                clientConfiguration: ClientConfiguration = .default,
                sessionConfiguration: URLSessionConfiguration = .default,
                persistenceIntegration: PersistenceIntegration? = nil,
                contentModel: ContentModel? = nil)

Parameters

`spaceId`	The space you want to perform requests against.
`accessToken`	The access token used for authorization.
`clientConfiguration`	Custom Configuration of the Client.
`sessionConfiguration`	The configuration for the URLSession. Note that HTTP headers will be overwritten interally by the SDK so that requests can be authorized correctly.
`persistenceIntegration`	An object conforming to the `PersistenceIntegration` protocol which will receive messages about created/deleted Resources when calling `sync()` methods.

Return Value

An initialized client instance.

Show on GitHub


                    
                    
                    fetchSpace(then:)

Fetch the space this client is constrained to.

Declaration

Swift

@discardableResult public func fetchSpace(then completion: @escaping ResultsHandler<Space>) -> URLSessionDataTask?

Parameters


                                completion

A handler being called on completion of the request.

Return Value

The data task being used, which enables cancellation of requests, or nil if the. Space was already cached locally

Show on GitHub

fetchSpace()
Fetch the space this client is constrained to.
Declaration
Swift

@discardableResult public func fetchSpace() -> Observable<Result<Space>>
Return Value

A tuple of data task and a signal for the resulting Space.

Show on GitHub


                    
                    
                    fetchEntries(with:then:)

Fetch a collection of Entries from Contentful matching the specified query. This method does not specify the content_type in the query parameters, so the entries returned in the results can be of any type.

Declaration

Swift

@discardableResult public func fetchEntries(with query: Query,
                                                then completion: @escaping ResultsHandler<ArrayResponse<Entry>>) -> URLSessionDataTask?

Parameters

`query`	The Query object to match results againts.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchEntries(with:)

Fetch a collection of Entries from Contentful matching the specified query. This method does not specify the content_type in the query parameters, so the entries returned in the results can be of any type.

Declaration

Swift

@discardableResult public func fetchEntries(with query: Query) -> Observable<Result<ArrayResponse<Entry>>>

Parameters


                                query

The Query object to match results againts.

Return Value

A tuple of data task and an observable for the resulting array of Entry’s.

Show on GitHub


                    
                    
                    fetchAssets(with:then:)

Fetch a collection of Assets from Contentful matching the specified query.

Declaration

Swift

@discardableResult public func fetchAssets(with query: AssetQuery,
                                               then completion: @escaping ResultsHandler<ArrayResponse<Asset>>) -> URLSessionDataTask?

Parameters

`query`	The Query object to match results againts.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchAssets(query:)

Fetch a collection of Assets from Contentful matching the specified query.

Declaration

Swift

@discardableResult public func fetchAssets(query: AssetQuery) -> Observable<Result<ArrayResponse<Asset>>>

Parameters


                                query

The Query object to match results againts.

Return Value

A tuple of data task and an observable for the resulting array of Assets.

Show on GitHub


                    
                    
                    fetchMappedEntries(with:)

Fetch a collection of Assets from Contentful matching the specified query.

Declaration

Swift

@discardableResult public func fetchMappedEntries(with query: Query) -> Observable<Result<MappedContent>>

Parameters


                                query

The Query object to match results againts.

Return Value

An Observable forr the resulting MappedContent container.

Show on GitHub


                    
                    
                    fetchMappedEntries(with:then:)

Fetches all entries and includes matching the passed in Query. The completion handler returned will return a MappedContent object which contains an array of Assets and a dictionary of ContentTypeId’s to arrays of EntryModellable types of your own defining.

Declaration

Swift

@discardableResult public func fetchMappedEntries(with query: Query,
                                                      then completion: @escaping ResultsHandler<MappedContent>) -> URLSessionDataTask?

Parameters

`query`	The Query object to match results against.
`completion`	A handler being called on completion of the request containing a `MappedContent` instance.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchAsset(id:completion:)

Fetch a single Asset from Contentful.

Declaration

Swift

@discardableResult public func fetchAsset(id: String, completion: @escaping ResultsHandler<Asset>) -> URLSessionDataTask?

Parameters

`id`	The identifier of the Asset to be fetched.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchAsset(id:)

Fetch a single Asset from Contentful.

Declaration

Swift

@discardableResult public func fetchAsset(id: String) -> Observable<Result<Asset>>

Parameters

`id`	The identifier of the Asset to be fetched.

Return Value

A tuple of data task and a signal for the resulting Asset.

Show on GitHub


                    
                    
                    fetchAssets(matching:completion:)

Fetch a collection of Assets from Contentful.

Declaration

Swift

@discardableResult public func fetchAssets(matching: [String: Any] = [:],
                                               completion: @escaping ResultsHandler<ArrayResponse<Asset>>) -> URLSessionDataTask?

Parameters

`matching`	An optional list of search parameters the Assets must match.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchAssets(matching:)

Fetch a collection of Assets from Contentful.

Declaration

Swift

@discardableResult public func fetchAssets(matching: [String: Any] = [:]) -> Observable<Result<ArrayResponse<Asset>>>

Parameters


                                matching

Optional list of search parameters the Assets must match.

Return Value

A tuple of data task and a signal for the resulting array of Assets.

Show on GitHub


                    
                    
                    fetchData(for:with:)

Fetch the underlying media file as Data.

Declaration

Swift

public func fetchData(for asset: Asset, with imageOptions: [ImageOption] = []) -> Observable<Result<Data>>

Parameters

`asset`	The `Asset` which contains the relevant media file.
`imageOptions`	An optional array of options for server side manipulations.

Return Value

Tuple of the data task and a signal for the Data result.

Show on GitHub


                    
                    
                    fetchContentType(id:completion:)

Fetch a single Content Type from Contentful.

Declaration

Swift

@discardableResult public func fetchContentType(id: String,
                                                    completion: @escaping ResultsHandler<ContentType>) -> URLSessionDataTask?

Parameters

`id`	The identifier of the Content Type to be fetched.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchContentType(id:)

Fetch a single Content Type from Contentful.

Declaration

Swift

@discardableResult public func fetchContentType(id: String) -> Observable<Result<ContentType>>

Parameters

`id`	The identifier of the Content Type to be fetched.

Return Value

A tuple of data task and a signal for the resulting Content Type.

Show on GitHub


                    
                    
                    fetchContentTypes(matching:completion:)

Fetch a collection of Content Types from Contentful.

Declaration

Swift

@discardableResult public func fetchContentTypes(matching: [String: Any] = [:],
                                                     completion: @escaping ResultsHandler<ArrayResponse<ContentType>>) -> URLSessionDataTask?

Parameters

`matching`	Optional list of search parameters the Content Types must match.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchContentTypes(matching:)

Fetch a collection of Content Types from Contentful.

Declaration

Swift

@discardableResult public func fetchContentTypes(matching: [String: Any] = [:]) -> Observable<Result<ArrayResponse<ContentType>>>

Parameters


                                matching

Optional list of search parameters the Content Types must match.

Return Value

A tuple of data task and a signal for the resulting array of Content Types.

Show on GitHub


                    
                    
                    fetchEntries(matching:completion:)

Fetch a collection of Entries from Contentful.

Declaration

Swift

@discardableResult public func fetchEntries(matching: [String: Any] = [:],
                                                completion: @escaping ResultsHandler<ArrayResponse<Entry>>) -> URLSessionDataTask?

Parameters

`matching`	Optional list of search parameters the Entries must match.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests

Show on GitHub


                    
                    
                    fetchEntries(matching:)

Fetch a collection of Entries from Contentful.

Declaration

Swift

@discardableResult public func fetchEntries(matching: [String: Any] = [:]) ->  Observable<Result<ArrayResponse<Entry>>>

Parameters


                                matching

Optional list of search parameters the Entries must match.

Return Value

A tuple of data task and a signal for the resulting array of Entries.

Show on GitHub


                    
                    
                    fetchEntry(id:completion:)

Fetch a single Entry from Contentful.

Declaration

Swift

@discardableResult public func fetchEntry(id: String,
                                              completion: @escaping ResultsHandler<Entry>) -> URLSessionDataTask?

Parameters

`id`	The identifier of the Entry to be fetched.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    fetchEntry(id:)

Fetch a single Entry from Contentful.

Declaration

Swift

@discardableResult public func fetchEntry(id: String) ->  Observable<Result<Entry>>

Parameters

`id`	The identifier of the Entry to be fetched.

Return Value

A tuple of data task and a signal for the resulting Entry.

Show on GitHub


                    
                    
                    initialSync(matching:completion:)

Perform an initial synchronization of the Space this client is constrained to.

Declaration

Swift

@discardableResult public func initialSync(matching: [String: Any] = [:],
                                               completion: @escaping ResultsHandler<SyncSpace>) -> URLSessionDataTask?

Parameters

`matching`	Additional options for the synchronization.
`completion`	A handler being called on completion of the request.

Return Value

The data task being used, enables cancellation of requests.

Show on GitHub


                    
                    
                    initialSync(matching:)

Perform an initial synchronization of the Space this client is constrained to.

Declaration

Swift

@discardableResult public func initialSync(matching: [String: Any] = [:]) -> Observable<Result<SyncSpace>>

Parameters


                                matching

Additional options for the synchronization.

Return Value

A tuple of data task and a signal for the resulting SyncSpace.

Show on GitHub


                    
                    
                    nextSync(for:matching:completion:)

Perform a subsequent synchronization operation, updating the passed in SyncSpace with the latest content from Contentful.

Calling this will mutate passed in SyncSpace and also return a reference to itself to the completion handler in order to allow chaining of operations.

Declaration

Swift

@discardableResult public func nextSync(for syncSpace: SyncSpace,
                                            matching: [String: Any] = [:],
                                            completion: @escaping ResultsHandler<SyncSpace>) -> URLSessionDataTask?

Parameters

`syncSpace`	the relevant `SyncSpace` to perform the subsequent sync on.
`matching`	Additional options for the synchronization
`completion`	A handler which will be called on completion of the operation

Return Value

The data task being used, enables cancellation of requests

Show on GitHub

fetchImage(for:with:)
Fetch the underlying media file as UIImage.
Declaration
Swift

public func fetchImage(for asset: Asset, with imageOptions: [ImageOption] = []) -> Observable<Result<UIImage>>
Return Value

The signal for the UIImage result

Show on GitHub