- ClearDynamicRoutesMessage
- MessageServiceWorkerResult
- NetworkRequestFailedEvent
- OmrsServiceWorkerEvent
- OmrsServiceWorkerMessage
- OnImportMapChangedMessage
- QueueItemDescriptor
- RegisterDynamicRouteMessage
- SyncProcessOptions
- dispatchNetworkRequestFailed
- generateOfflineUuid
- getOmrsServiceWorker
- getSynchronizationItems
- getSynchronizationItemsFor
- isOfflineUuid
- messageOmrsServiceWorker
- patchXMLHttpRequest
- queueSynchronizationItem
- queueSynchronizationItemFor
- registerOmrsServiceWorker
- setupOfflineSync
- subscribeNetworkRequestFailed
- triggerSynchronization
Ƭ KnownOmrsServiceWorkerEvents: NetworkRequestFailedEvent
Ƭ KnownOmrsServiceWorkerMessages: OnImportMapChangedMessage | ClearDynamicRoutesMessage | RegisterDynamicRouteMessage
service-worker-messaging.ts:36
• Const offlineUuidPrefix: "OFFLINE+"
▸ dispatchNetworkRequestFailed(data): void
| Name | Type |
|---|---|
data |
NetworkRequestFailedEvent |
void
▸ generateOfflineUuid(): string
Generates a UUID-like string which is used for uniquely identifying objects while offline.
string
▸ getOmrsServiceWorker(): Promise<Workbox>
Returns a Workbox instance which allows interacting with the application's global Service Worker.
Warning: The promise may never resolve if the Service Worker is never registered (which can, for example, happen when the browser is missing the required capabilities).
Promise<Workbox>
A promise which will resolve once the application's Service Worker has been initialized.
▸ getSynchronizationItems<T>(type): Promise<T[]>
| Name |
|---|
T |
| Name | Type |
|---|---|
type |
string |
Promise<T[]>
▸ getSynchronizationItemsFor<T>(userId, type): Promise<T[]>
| Name |
|---|
T |
| Name | Type |
|---|---|
userId |
string |
type |
string |
Promise<T[]>
▸ isOfflineUuid(uuid): boolean
Checks whether the given string has the format of an offline UUID generated by generateOfflineUuid
| Name | Type |
|---|---|
uuid |
string |
boolean
▸ messageOmrsServiceWorker(message): Promise<MessageServiceWorkerResult<any>>
Sends the specified message to the application's service worker.
| Name | Type | Description |
|---|---|---|
message |
KnownOmrsServiceWorkerMessages | The message to be sent. |
Promise<MessageServiceWorkerResult<any>>
A promise which completes when the message has been successfully processed by the Service Worker.
▸ patchXMLHttpRequest(): void
void
▸ queueSynchronizationItem<T>(type, content, descriptor?): Promise<number>
| Name |
|---|
T |
| Name | Type |
|---|---|
type |
string |
content |
T |
descriptor? |
QueueItemDescriptor |
Promise<number>
▸ queueSynchronizationItemFor<T>(userId, type, content, descriptor?): Promise<number>
| Name |
|---|
T |
| Name | Type |
|---|---|
userId |
string |
type |
string |
content |
T |
descriptor? |
QueueItemDescriptor |
Promise<number>
▸ registerOmrsServiceWorker(scriptUrl, registerOptions?): Workbox
If not yet registered, registers the application's global Service Worker. Throws if registration is not possible.
| Name | Type |
|---|---|
scriptUrl |
string |
registerOptions? |
object |
Workbox
The registered Service Worker.
▸ setupOfflineSync<T>(type, dependsOn, process): void
| Name |
|---|
T |
| Name | Type |
|---|---|
type |
string |
dependsOn |
string[] |
process |
(item: T, options: SyncProcessOptions<T>) => Promise<any> |
void
▸ subscribeNetworkRequestFailed(cb): () => void
| Name | Type |
|---|---|
cb |
(data: NetworkRequestFailedEvent) => void |
fn
▸ (): void
void
▸ triggerSynchronization(abort): Promise<void>
| Name | Type |
|---|---|
abort |
AbortController |
Promise<void>