OfflineDataService

Construct an offline data service using an offline provider.

Cancel any download(s) that are currently in progress.

(Asynchronous) Cancel any download(s) that are currently in progress.

Cancel the specifed pending requests. The requests should be cancelled as a batch, which might perform better than calling PendingRequest.cancel one request at a time.

(Asynchronous) Cancel the specifed pending requests. The requests should be cancelled as a batch, which might perform better than calling PendingRequest.cancel one request at a time.

Cancel any upload(s) that are currently in progress.

(Asynchronous) Cancel any upload(s) that are currently in progress.

Clear the syncProvider, destroying the local database. This does not communicate with the backend system.

(Asynchronous) Clear the syncProvider, destroying the local database. This does not communicate with the backend system.

Close the syncProvider, disconnecting from the local database. This does not communicate with the backend system.

(Asynchronous) Close the syncProvider, disconnecting from the local database. This does not communicate with the backend system.

Create a persistent query to specify criteria for downloading entities for an entity set. This query is persisted across application restarts. Multiple download queries can be defined for the same entity set (e.g. with different filters).

(Asynchronous) Create a persistent query to specify criteria for downloading entities for an entity set. This query is persisted across application restarts. Multiple download queries can be defined for the same entity set (e.g. with different filters).

Delete a persistent query previously created by createDownloadQuery, along with any previously downloaded associated entities. Note: if there is a large number of previously downloaded associated entities, deletion of the download query might be time-consuming. Consider invoking this method in a background thread to avoid blocking the application’s user interface thread.

(Asynchronous) Delete a persistent query previously created by createDownloadQuery, along with any previously downloaded associated entities. Note: if there is a large number of previously downloaded associated entities, deletion of the download query might be time-consuming. Consider invoking this method in a background thread to avoid blocking the application’s user interface thread.

Download backend data changes into the local database.

Example using proxy classes

open func downloadExample() throws -> Void {
    let service = self.healthService
    try service.download(groups: StringList.of("PatientGroup", "StaffGroup"))
}

(Asynchronous) Download backend data changes into the local database.

Example using proxy classes

open func downloadExample() throws -> Void {
    let service = self.healthService
    try service.download(groups: StringList.of("PatientGroup", "StaffGroup"))
}

Return a named download group; the group is created if it doesn’t exist already. Download groups are not remembered across application restart. Download groups should be configured before calling download or before calling open (in the case that open may perform an implicit download).

Configure one or more entity sets to be downloaded in a named group, equivalent to calling getDownloadGroup(group).add(...). Download groups are used to limit the entity sets to be downloaded. This function is helpful when using generated proxy classes which provide convenient access to entity set objects (e.g. MyService.customers, MyService.orders). If you need to configure a group using entity set names (e.g. with the dynamic API), nested group names, or download query names, then call getDownloadGroup and use the returned object for configuration. Note: this function does not actually perform the download. It simply configures entity sets for later download calls.

Retrieve all of the persistent queries previously created by createDownloadQuery for a specified entity set.

(Asynchronous) Retrieve all of the persistent queries previously created by createDownloadQuery for a specified entity set.

Retrieve a persistent query previously created by createDownloadQuery.

(Asynchronous) Retrieve a persistent query previously created by createDownloadQuery.

(Asynchronous) @return a list of the synchronization events since the local database was created.

(Asynchronous) @return a list of the failed pending requests in the local database (matching the query, if specified).

The online provider supporting this data service.

Open the syncProvider, performing any necessary initialization such as creation of the local database. Depending on the provider implementation, the first call to open might (or might not) communicate with the backend system. If hasInitialData returns false after calling open, then download must be explicitly called to obtain initial data. If hasInitialData returns true after calling open, then initial data has already been obtained from the backend system.

(Asynchronous) Open the syncProvider, performing any necessary initialization such as creation of the local database. Depending on the provider implementation, the first call to open might (or might not) communicate with the backend system. If hasInitialData returns false after calling open, then download must be explicitly called to obtain initial data. If hasInitialData returns true after calling open, then initial data has already been obtained from the backend system.

In a multiple user scenario, when a new user starts using the application on a mobile device, it might have pending requests in the local database that need to be uploaded using the previous user’s identity. This function can be called before open is called to determine whether special action is needed. Calling open when there is a known previous user might result in upload and/or download being called by open.

(Asynchronous) @return a list of the queued pending requests in the local database (matching the query, if specified). This includes requests that have never been sent to the backend system, as well as requests that were previously sent but which failed.

Service options for the associated online provider.

The synchronization provider supporting this data service.

Undo all pending (local) changes for entities, so they will not be subsequently uploaded. For best performance, if multiple entities are to be undone, make one call with an EntityValueList rather than multiple calls with an EntityValue.

(Asynchronous) Undo all pending (local) changes for entities, so they will not be subsequently uploaded. For best performance, if multiple entities are to be undone, make one call with an EntityValueList rather than multiple calls with an EntityValue.

Upload local pending changes to the backend OData service.

(Asynchronous) Upload local pending changes to the backend OData service.

Upload a copy of the local database file (or files) to the backend server (or an intermediary server) for diagnostic purposes. Note: if the local database is encrypted, and encryptionKey is null, this operation might fail (depending on the provider). Note: if the local database is not encrypted, and encryptionKey is non-null, this operation might fail (depending on the provider).

(Asynchronous) Upload a copy of the local database file (or files) to the backend server (or an intermediary server) for diagnostic purposes. Note: if the local database is encrypted, and encryptionKey is null, this operation might fail (depending on the provider). Note: if the local database is not encrypted, and encryptionKey is non-null, this operation might fail (depending on the provider).