SynchronizationManager

public class SynchronizationManager : PersistenceIntegration

Provides the ability to sync content from Contentful to a persistence store.

Show on GitHub

DBVersions
Undocumented
See more
Declaration
Swift

public enum DBVersions : Int
Show on GitHub

Integration

name
Declaration
Swift

public let name: String
Show on GitHub
version
Declaration
Swift

public var version: String { get }
Show on GitHub


                    
                    
                    init(client:localizationScheme:persistenceStore:persistenceModel:)

Instantiate a new SynchronizationManager.

Declaration

Swift

public init(client: Client? = nil,
            localizationScheme: LocalizationScheme,
            persistenceStore: PersistenceStore,
            persistenceModel: PersistenceModel)

Parameters

`persistenceStore`	The persistence store to use for storage
`matching`	An optional query for syncing specific content, see

Return Value

An initialised instance of SynchronizationManager

Show on GitHub


                    
                    
                    init(client:localizationScheme:persistenceStore:persistenceModel:preseedConfig:preseedStrategy:)

Undocumented

Declaration

Swift

public convenience init(client: Client? = nil,
            localizationScheme: LocalizationScheme,
            persistenceStore: PersistenceStore,
            persistenceModel: PersistenceModel,
            preseedConfig: PreseedConfiguration,
            preseedStrategy: PreseedStrategy = FilePreseedManager()) throws

Show on GitHub

update(localeCodes:)
Declaration
Swift

public func update(localeCodes: [LocaleCode])
Show on GitHub


                    
                    
                    sync(syncSpacePersistable:initialLocalizationScheme:limit:dbVersion:onInitialCompletion:onFinalCompletion:)

Synchronizes data using the provided localization scheme, performing a follow-up sync with all localizations if required.

Throws

An assertion failure if initialLocalizationScheme is .all.

The synchronization process involves two phases:
1. Synchronizing data with the provided localization scheme.
2. Resetting the synchronization token and synchronizing with .all localizations. The onInitialCompletion closure is invoked after the first phase, and the final result is passed to the onFinalCompletion closure.

Declaration

Swift

public func sync<SSP>(
    syncSpacePersistable: SSP.Type,
    initialLocalizationScheme: LocalizationScheme,
    limit: Int? = nil,
    dbVersion: Int = DBVersions.default.rawValue,
    onInitialCompletion: @escaping ResultsHandler<SyncSpace>,
    onFinalCompletion: @escaping ResultsHandler<SyncSpace>
) throws where SSP: SyncSpacePersistable

Parameters

`syncSpacePersistable`	The type conforming to `SyncSpacePersistable` used for handling synchronization data.
`initialLocalizationScheme`	The localization scheme to use for the initial synchronization phase. This must not be `.all`.
`limit`	An optional limit for the number of records to synchronize in one batch. Defaults to `nil`, indicating no limit.
`dbVersion`	The database version targeted for synchronization. Defaults to the application’s default database version.
`onInitialCompletion`	A closure called upon completion of the initial synchronization phase, with a `Result` containing either the `SyncSpace` or an error.
`onFinalCompletion`	A closure called upon completion of the final synchronization phase, with a `Result` containing either the `SyncSpace` or an error.

Show on GitHub


                    
                    
                    sync(limit:dbVersion:then:)

A wrapper method to synchronize data from Contentful to your local data store. The callback for this method is thread safe and will delegate to the thread that your data store is tied to.

Execute queries on your local data store in the callback for this method.

Declaration

Swift

public func sync(limit: Int? = nil, dbVersion: Int = DBVersions.default.rawValue, then completion: @escaping ResultsHandler<SyncSpace>)

Parameters


                                limit

Number of elements per page. See documentation for details.

Show on GitHub

client
The Contentful.Client that is configured to retrieve data from your Contentful space.
Declaration
Swift

public var client: Client?
Show on GitHub
localizationScheme
The localization scheme with which to synchronize your Contentful space to your data store.
Declaration
Swift

public var localizationScheme: LocalizationScheme
Show on GitHub
syncToken
Undocumented
Declaration
Swift

public var syncToken: String? { get }
Show on GitHub
performAndWait(block:)
Undocumented
Declaration
Swift

public func performAndWait(block: @escaping () -> Void)
Show on GitHub


                    
                    
                    update(with:)

Declaration

Swift

public func update(with syncSpace: SyncSpace)

Show on GitHub

update(syncToken:)
Declaration
Swift

public func update(syncToken: String)
Show on GitHub
resolveRelationships()
Declaration
Swift

public func resolveRelationships()
Show on GitHub

PersistenceDelegate


                    
                    
                    create(asset:)

This function is public as a side-effect of implementing PersistenceDelegate.

Declaration

Swift

public func create(asset: Asset)

Parameters


                                asset

The newly created Asset

Show on GitHub

create(entry:)
Never call this directly. This function is public as a side-effect of implementing SyncSpaceDelegate.
Declaration
Swift

public func create(entry: Entry)
Show on GitHub


                    
                    
                    delete(assetWithId:)

This function is public as a side-effect of implementing PersistenceDelegate.

Declaration

Swift

public func delete(assetWithId: String)

Parameters


                                assetId

The ID of the deleted Asset

Show on GitHub


                    
                    
                    delete(entryWithId:)

This function is public as a side-effect of implementing SyncSpaceDelegate.

Declaration

Swift

public func delete(entryWithId: String)

Parameters


                                entryId

The ID of the deleted Entry

Show on GitHub

save()
Declaration
Swift

public func save()
Show on GitHub

Unresolved relationship caching

pendingRelationshipsURL
The local URL where unresolved relationships are cached so that they may be resolved on future app launches. Useful for debugging.
Declaration
Swift

public var pendingRelationshipsURL: URL? { get }
Show on GitHub
cachedUnresolvedRelationships
The unsresolved relationships that were cached to disk.
Declaration
Swift

public var cachedUnresolvedRelationships: [String : [FieldName : Any]]? { get }
Show on GitHub


                    
                    
                    seedDBFromJSONFiles(in:in:)

This method will seed a CoreData datastore from a directory of JSON files in the specified Bundle. Use this method in conjunction with the ContentfulBundleSync command line interface.

Throws

Errors if the media the files in the directory can’t be deserialized.

Declaration

Swift

func seedDBFromJSONFiles(in directory: String, in bundle: Bundle) throws

Parameters

`directory`	The name of the directory in your bundle which contains your Contentful JSON and media assets generated by the CLI.
`bundle`	The bundle in which your directory containing your Contentful data is located.

Show on GitHub


                    
                    
                    pathInBundle(for:inDirectoryNamed:in:)

Returns the local path for media assets that have been bundled in your app’s bundle for the passed in Asset or AssetPersistable. This only works if you’ve used the ContentfulBundleSync command line tool.

Declaration

Swift

static func pathInBundle(for media: AssetProtocol, inDirectoryNamed directory: String, in bundle: Bundle) -> String?

Parameters

`media`	The Asset or AssetPersistable for which on-disk data should be retreived.
`directory`	The name of the directory in your bundle which contains the media data
`bundle`	The bundle in which your directory containing your media files is located.

Return Value

The full string path for the underlying media file associated with the passed in Asset or AssetPersistabl. Will return nil if no directory exists at your directory name, or if the Media does not have a valid urlString associated with it.

Show on GitHub


                    
                    
                    bundledData(for:inDirectoryNamed:in:)

Returns on-disk data that is bundled in your app’s bundle for the passed in Asset or AssetPersistable. This only works if you’ve used the ContentfulBundleSync command line tool.

Declaration

Swift

static func bundledData(for media: AssetProtocol, inDirectoryNamed directory: String, in bundle: Bundle) -> Data?

Parameters

`media`	The Asset or AssetPersistable for which on-disk data should be retreived.
`directory`	The name of the directory in your bundle which contains the media data
`bundle`	The bundle in which your directory containing your media files is located.

Return Value

The Data object for your media file. Will return nil if no directory exists at your directory name, or if the Media does not have a urlString associated with it.

Show on GitHub


                    
                    
                    fileName(for:)

Returns a file name to be used for local storage given a passed in Asset or AssetPersistable.

Declaration

Swift

static func fileName(for media: AssetProtocol) -> String?

Parameters


                                media

The Asset or AssetPersistable for which a file name should be computed.

Return Value

A filename for the underlying media file. Will return nil if the Asset or AssetPersistable does not have a urlString associated with it.

Show on GitHub

DatabaseSeedingError
Errors thrown by ContentfulPersistence when trying to seed a database with bundled data.
See more
Declaration
Swift

enum DatabaseSeedingError : Swift.Error, CustomDebugStringConvertible
Show on GitHub