Xrm.WebApi.offline (Client API reference)

Provides methods to create and manage records in the model-driven apps mobile clients while working in the offline mode.

For information about the mobile offline feature, see Configure mobile offline synchronization to allow users to work in offline mode on their mobile device

var offlineWebApi = Xrm.WebApi.offline;

Note

Use Xrm.WebApi.offline instead of the deprecated Xrm.Mobile.Offline namespace to create and manage records in the mobile clients while working in the offline mode.

The offlineWebApi object provides the following methods. When in the offline mode, these methods will work only for entities that are enabled for mobile offline synchronization and available in current user’s mobile offline profile.

Important

While creating or updating record in the offline mode, only basic validation is performed on the input data. Basic validation includes things such as ensuring that the entity attribute name specified is in lower case and does exist for an entity, checking for data type mismatch for the specified attribute value, preventing records getting created with the same GUID value, checking whether the related entity is offline enabled when retrieving related entity records, and validating if the record that you want to retrieve, update, or delete actually exists in the offline data store. Business-level validations happen only when you are connected to the server and the data is synchronized. A record is created or updated only if the input data is completely valid.

Xrm.WebApi.online

Xrm.WebApi