1. class
  2. Contentful
  3. \
  4. Delivery
  5. \
  6. Synchronization
  7. \
  8. Manager

Manager

class Manager

The synchronization Manager can be used to sync a Space to this server.

It provides notifications about added, updated and deleted assets and entries.

Methods

__construct(SynchronizationClientInterface $client, ResourceBuilderInterface $builder, bool $isDeliveryApi)

Manager constructor.

Generator
sync(string $token = \null, Query $query = \null)

No description

Result
startSync(Query $query = \null)

Starts a new Synchronization.

Result
continueSync(string|Result $token)

Continues the synchronization either at the next page, or with the results since the initial synchronization.

Details

at line 54
__construct(SynchronizationClientInterface $client, ResourceBuilderInterface $builder, bool $isDeliveryApi)

Manager constructor.

Do not instantiate this class yourself, use SynchronizationClientInterface::getSynchronizationManager() instead.

Parameters

SynchronizationClientInterface $client
ResourceBuilderInterface $builder
bool $isDeliveryApi

See also

Client::getSynchronizationManager()

at line 70
Generator sync(string $token = \null, Query $query = \null)

Parameters

string $token
Query $query

Return Value

Generator An instance of Result wrapped in a Generator object

at line 93
Result startSync(Query $query = \null)

Starts a new Synchronization.

The result will contain all the resources currently present in the space. By calling Result::isDone(), it can be checked if there's another page of results, if so call continueSync to get the next page.

A Query object can be used to return only a subset of the space.

Parameters

Query $query

Return Value

Result

at line 111
Result continueSync(string|Result $token)

Continues the synchronization either at the next page, or with the results since the initial synchronization.

Parameters

string|Result $token

Return Value

Result

Exceptions

RuntimeException if this method is used for a subsequent sync when used with the Preview API