client static method

  1. @Deprecated('Use the SyncClient constructor instead')
SyncClient client(
  1. Store store,
  2. String serverUrl,
  3. SyncCredentials credentials, {
  4. Map<String, String>? filterVariables,
  5. List<String>? certificatePaths,
  6. int? flags,
})

Creates a SyncClient associated with the given store and configures it with the given options. This does not initiate any connection attempts yet, call SyncClient.start to do so.

By default, a Sync client automatically receives updates from the server once login succeeded. To configure this differently, call SyncClient.setRequestUpdatesMode with the wanted mode.

To configure Sync filter variables, pass variable names mapped to their value to filterVariables.

Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match the filter.

To, for example, use self-signed certificates in a local development environment or custom CAs, pass certificate paths referring to the local file system to certificatePaths.

To configure Sync behavior, pass bitwise OR-ed OBXSyncFlags values to flags. See OBXSyncFlags for available flags.

Implementation

@Deprecated('Use the SyncClient constructor instead')
static SyncClient client(
        Store store, String serverUrl, SyncCredentials credentials,
        {Map<String, String>? filterVariables,
        List<String>? certificatePaths,
        int? flags}) =>
    SyncClient(store, [serverUrl], [credentials],
        filterVariables: filterVariables,
        certificatePaths: certificatePaths,
        flags: flags);