Skip to content


StoreParameters Properties

Property Type Required Default
AutoRegisterClient boolean No false
EnableBackgroundDataTransfer boolean No true
EnableIndividualErrorArchiveDeletion boolean No false
EnableRepeatableRequests boolean No true
EnableRequestQueueOptimization boolean No false
EnableUndoLocalCreation boolean No false
StoreName string No
Timeout number No


Specifies whether or not to enable Client Registrations.

  • type: boolean
  • default: false


Specifies whether or not to enable background data transfer. Applicable only for iOS devices.

  • type: boolean
  • default: true


By default, deletion of an individual ErrorArchive entity will clear all entities in the ErrorArchive and all pending requests related to them will also be removed from the requests queue. If set to true, deletion of an individual ErrorArchive entity will only delete that entity and its dependent entities. In addition, pending requests associated with the deleted entities in the ErrorArchive are also removed from the requests queue. All other non-related entities will not be removed.

  • type: boolean
  • default: false


Specifies whether the OData backend or mobile services supports repeatable requests.

  • type: boolean
  • default: true


Specifies whether or not to enable request queue optimization.

  • type: boolean
  • default: false


Specifies whether or not to enable an optimization such that deleting an entity that was created locally but not yet uploaded undoes the creation.

  • type: boolean
  • default: false


By default, the service destination name will be used as Store Name. The StoreName must be defined if service PathSuffix is defined.

  • type: string


Defines the timeout value in seconds. If the timeout is set too low (less than 30 seconds), it would increase network traffic for checking the liveness of the connection which each timeout period to ensure that the connection is still active. If omitted, it will be no timeout.

  • type: number