Difference between revisions of "Branch Download"

Revision as of 10:28, 22 December 2020

To support offline use cases, UBIK^® clients provide the possibility to bring data offline. It's achieved by downloading specified data branches in advance.

Manual Download

When using the clients in non-offline sync modes, you can trigger a branch download from any content object. Depending on the clients and the XAML customizings, the UI for starting branch downloads might differ. Here's the default UI on different clients.

button in bottom bar (UWP)
button in page menu (Xamarin)
button in item swipe menu (Xamarin)

Manual downloads always have higher priorities than automatic downloads. More specifically, a manual download will "cut in line" in front of all automatic downloads (except if one is already in the middle of executing).

Automatic Download

Content objects can be classified in a way that their branches are automatically downloaded to the clients. Different configurations are supported so that the download can happen at different timing.

Download States

To help users better understand what is going on during a branch download, the clients display different icons. The following examples are from the Xamarin clients.

pending (to run at least once, see Automatic Download)
syncing
synced
failed

All states are displayed for an entire branch. If the parent (direct or indirect) of a child object is syncing, that child object will display the same syncing state.

States are displayed in different priorities (syncing > pending > synced/failed). For example, if a child object is syncing and its parent is pending, the child object will "retain" its syncing state. But if their states are switched, the child object's pending state will be "overwritten" by the parent's syncing state. As for the synced/failed states, the more recent one is displayed.