Skip to content

ProgressMessages

Custom format strings are used to override the default localized progress messages for offline OData operations. Each property corresponds to a specific operation step and accepts a format string with placeholders.

Placeholders:

  • {0} = current step number
  • {1} = total number of steps
  • {2} = step-specific value (varies by step)
  • {3} = optional additional step-specific value (varies by step)

Note: Byte values are automatically formatted (e.g., 1.50 MB)

Step -> supported values:

ProcessingDefiningQueries:

  • {2} = request name
  • {3} = request URL

ProcessingRequests:

  • {2} = request number
  • {3} = total requests

ReceivingDataFromServer:

  • {2} = received bytes

SendingDataToServer:

  • {2} = sent bytes

DownloadingEntityStore:

  • {2} = received bytes
  • {3} = total bytes

SendingEntityStoreDatabase:

  • {2} = sent bytes
  • {3} = total bytes

ProgressMessages Properties

Property Type Required Nullable Defined by
BuildingEntityStore string Optional cannot be null ProgressMessages
CreatingBootStrapDatabase string Optional cannot be null ProgressMessages
CreatingRequestQueueDatabase string Optional cannot be null ProgressMessages
DownloadingEntityStore string Optional cannot be null ProgressMessages
ErasingExpiredRequests string Optional cannot be null ProgressMessages
LoadingMetadata string Optional cannot be null ProgressMessages
PerformingTransactionMerge string Optional cannot be null ProgressMessages
PerformingCreateDeleteMerge string Optional cannot be null ProgressMessages
ProcessingDefiningQueries string Optional cannot be null ProgressMessages
ProcessingRequests string Optional cannot be null ProgressMessages
ReapplyingChanges string Optional cannot be null ProgressMessages
AnalyzingReceivedData string Optional cannot be null ProgressMessages
ReceivingDataFromServer string Optional cannot be null ProgressMessages
RemovingDeletedRelationships string Optional cannot be null ProgressMessages
RemovingRemoveAfterUploadRequests string Optional cannot be null ProgressMessages
SendingDataToServer string Optional cannot be null ProgressMessages
SendingEntityStoreDatabase string Optional cannot be null ProgressMessages
SendingRequestQueueDatabase string Optional cannot be null ProgressMessages
UploadPreprocessing string Optional cannot be null ProgressMessages
WaitingForDownload string Optional cannot be null ProgressMessages

BuildingEntityStore

Message shown when building the local entity store. Supports {0} (current step) and {1} (total steps).


CreatingBootStrapDatabase

Message shown when creating the bootstrap database. Supports {0} (current step) and {1} (total steps).


CreatingRequestQueueDatabase

Message shown when creating the request queue database. Supports {0} (current step) and {1} (total steps).


DownloadingEntityStore

Message shown when downloading the entity store from the server. Supports {0} (current step), {1} (total steps), {2} (received bytes), and {3} (total bytes).


ErasingExpiredRequests

Message shown when erasing expired requests. Supports {0} (current step) and {1} (total steps).


LoadingMetadata

Message shown when loading metadata. Supports {0} (current step) and {1} (total steps).


PerformingTransactionMerge

Message shown when performing transaction merge. Supports {0} (current step) and {1} (total steps).


PerformingCreateDeleteMerge

Message shown when performing create-delete merge optimization. Supports {0} (current step) and {1} (total steps).


ProcessingDefiningQueries

Message shown when processing defining queries. Supports {0} (current step), {1} (total steps), {2} (request name), and {3} (request URL).


ProcessingRequests

Message shown when processing requests. Supports {0} (current step), {1} (total steps), {2} (request number), and {3} (total requests).


ReapplyingChanges

Message shown when reapplying local changes. Supports {0} (current step) and {1} (total steps).


AnalyzingReceivedData

Message shown when analyzing received data. Supports {0} (current step) and {1} (total steps).


ReceivingDataFromServer

Message shown when receiving data from the server. Supports {0} (current step), {1} (total steps), and {2} (received bytes).


RemovingDeletedRelationships

Message shown when removing deleted relationships. Supports {0} (current step) and {1} (total steps).


RemovingRemoveAfterUploadRequests

Message shown when removing RemoveAfterUpload requests. Supports {0} (current step) and {1} (total steps).


SendingDataToServer

Message shown when sending data to the server. Supports {0} (current step), {1} (total steps), and {2} (sent bytes).


SendingEntityStoreDatabase

Message shown when sending the entity store database. Supports {0} (current step), {1} (total steps), {2} (sent bytes), and {3} (total bytes).


SendingRequestQueueDatabase

Message shown when sending the request queue database. Supports {0} (current step) and {1} (total steps).


UploadPreprocessing

Message shown during upload preprocessing. Supports {0} (current step) and {1} (total steps).


WaitingForDownload

Message shown when waiting for download. Supports {0} (current step) and {1} (total steps).