UNPKG

@openmrs/esm-framework

Version:

github.com/openmrs/openmrs-esm-core

openmrs/openmrs-esm-core

79 lines (43 loc) • 2.22 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
[@openmrs/esm-framework](../API.md) / DynamicOfflineData # Interface: DynamicOfflineData Represents the registration of a single dynamic offline data entry. ## Table of contents ### Offline Properties - [id](DynamicOfflineData.md#id) - [identifier](DynamicOfflineData.md#identifier) - [syncState](DynamicOfflineData.md#syncstate) - [type](DynamicOfflineData.md#type) - [users](DynamicOfflineData.md#users) ## Offline Properties ### id • `Optional` **id**: `number` The internal ID of the data entry, as assigned by the IndexedDB where it is stored. #### Defined in [packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48) ___ ### identifier • **identifier**: `string` The externally provided identifier of the data entry. This is typically the ID of the resource as assigned by a remote API. #### Defined in [packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58) ___ ### syncState • `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md) If this entry has already been synced, returns the result of that last sync attempt. Otherwise this is `undefined`. #### Defined in [packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67) ___ ### type • **type**: `string` The underlying type used for categorizing the data entry. Examples could be `"patient"` or `"form"`. #### Defined in [packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53) ___ ### users • **users**: `string`[] The UUIDs of the users who need this data entry available offline. #### Defined in [packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)