\n \n

\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"example","type":"text","marks":[{"type":"code"}]},{"text":" Passing a function as children","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n {(extension) => (\n

{extension.name}

\n \n

\n )}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"924a2a54-ba77-4acd-9a88-cdd1cb3c5e34"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"__namedParameters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ExtensionSlotProps","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Element","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/ExtensionSlot.tsx:81","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L81"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"attach","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"attach","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"slotName","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"extensionId","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Attach an extension to an extension slot.","type":"text"}]},{"type":"paragraph","content":[{"text":"This will cause the extension to be rendered into the specified extension slot, unless it is removed by configuration. Using ","type":"text"},{"text":"attach","type":"text","marks":[{"type":"code"}]},{"text":" is an alternative to specifying the ","type":"text"},{"text":"slot","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"slots","type":"text","marks":[{"type":"code"}]},{"text":" in the extension declaration.","type":"text"}]},{"type":"paragraph","content":[{"text":"It is particularly useful when creating a slot into which you want to render an existing extension. This enables you to do so without modifying the extension's declaration, which may be impractical or inappropriate, for example if you are writing a module for a specific implementation.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0a61ed90-55b5-452f-b4ba-d874126f645e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"slotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"a name uniquely identifying the slot","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"an extension name, with an optional #-suffix to distinguish it from other instances of the same extension attached to the same slot.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:143","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L143"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"detach","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"detach","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"extensionId","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Avoid using this. Extension attachments should be considered declarative.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"60dcff3c-5e05-4910-827b-f25a10a96bb6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:176","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L176"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"detachAll","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"detachAll","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Avoid using this. Extension attachments should be considered declarative.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c8a4ffcc-c9aa-4582-9d46-8ff94d4932b0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:200","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L200"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getAssignedExtensions","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getAssignedExtensions","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"slotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"AssignedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets the list of extensions assigned to a given slot","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"52b2999a-0210-4670-af4d-16f684675ed3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"slotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The slot to load the assigned extensions for","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"AssignedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"An array of extensions assigned to the named slot","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:335","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L335"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getConnectedExtensions","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getConnectedExtensions","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"assignedExtensions","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"online?","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"enabledFeatureFlags?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"ConnectedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Filters a list of extensions according to whether they support the current connectivity status.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a0e4c99b-7db7-4964-b517-81cd115dc59c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Default value","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"assignedExtensions","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AssignedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"undefined","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of extensions to filter.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"online","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"null","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Whether the app is currently online. If ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":", uses ","type":"text"},{"text":"navigator.onLine","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enabledFeatureFlags","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"null","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The names of all enabled feature flags. If ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":", looks up the feature flags using the feature flags API.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"ConnectedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of extensions that should be rendered","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:260","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L260"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getExtensionNameFromId","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getExtensionNameFromId","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"extensionId","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Given an extension ID, which is a string uniquely identifying an instance of an extension within an extension slot, this returns the extension name.","type":"text"}]},{"type":"paragraph","content":[{"text":"example","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"getExtensionNameFromId(\"foo#bar\")\n --> \"foo\"\ngetExtensionNameFromId(\"baz\")\n --> \"baz\"\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"222156de-acc7-43f8-8e37-38ccde663355"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/extensions.ts:91","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L91"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getExtensionStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getExtensionStore","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns a store that modules can use to get information about the state of the extension system.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/store.ts:124","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L124"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"renderExtension","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"renderExtension","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"domElement","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"extensionSlotModuleName","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"extensionId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"renderFunction?","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"additionalProps?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"Parcel","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Mounts into a DOM node (representing an extension slot) a lazy-loaded component from ","type":"text"},{"text":"any","type":"text","marks":[{"type":"em"}]},{"text":" frontend module that registered an extension component for this slot.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1d58d088-7ab6-4bdc-b709-e338191659da"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"domElement","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTMLElement","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionSlotModuleName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"renderFunction","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"application","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ParcelConfig","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"CustomProps","type":"text","marks":[{"type":"code"}]},{"text":">) => ","type":"text"},{"text":"ParcelConfig","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"CustomProps","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"additionalProps","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Record","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"Parcel","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-extensions/src/render.ts:18","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L18"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useAssignedExtensionIds","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useAssignedExtensionIds","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"slotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets the assigned extension ids for a given extension slot name. Does not consider if offline or online.","type":"text"}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Use ","type":"text"},{"text":"useAssignedExtensions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"67534fe1-2dc5-4dd6-9c63-684870d18aa5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"slotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the slot to get the assigned IDs for.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useAssignedExtensions","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useAssignedExtensions","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"slotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"AssignedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets the assigned extensions for a given extension slot name. Does not consider if offline or online.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2fc4ffe1-cd27-4e6e-8fc6-3e112290c896"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"slotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the slot to get the assigned extensions for.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"AssignedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useAssignedExtensions.ts:10","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L10"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useConnectedExtensions","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useConnectedExtensions","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"slotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"ConnectedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets the assigned extension for a given extension slot name. Considers if offline or online, and what feature flags are enabled.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"bcc700ee-74a8-49ed-9dab-47f9fe5492a0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"slotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the slot to get the assigned extensions for.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"ConnectedExtension","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L15"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useExtensionSlotMeta","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useExtensionSlotMeta","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Object","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Extract meta data from all extension for a given extension slot.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7335bf32-8dc9-4a6f-941a-4024eaf4c2dc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ExtensionMeta","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b64ab2a9-f3f4-4321-ac05-14f980841d9d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extensionSlotName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Object","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useExtensionStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useExtensionStore","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useExtensionStore.ts:6","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L6"}}]}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useExtensionStore","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"actions","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7a0d0150-b996-4291-8224-63e4676587d9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"actions","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useExtensionStore.ts:6","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L6"}}]}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useExtensionStore","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"actions?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"80cb5fed-e48e-4ab8-9366-f397a6c4bcde"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"actions?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useExtensionStore.ts:6","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L6"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useRenderableExtensions","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useRenderableExtensions","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"React.FC","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"Pick","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionProps","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"\"state\"","type":"text","marks":[{"type":"code"}]},{"text":">>[]","type":"text"}]},{"type":"paragraph","content":[{"text":"This is an advanced hook for use-cases where its useful to use the extension system, but not the ","type":"text"},{"text":"ExtensionSlot","type":"text","marks":[{"type":"code"}]},{"text":" component's rendering of extensions. Use of this hook should be avoided if possible.","type":"text"}]},{"type":"paragraph","content":[{"text":"Functionally, this hook is very similar to the ","type":"text"},{"text":"ExtensionSlot","type":"text","marks":[{"type":"code"}]},{"text":" component, but whereas an ","type":"text"},{"text":"ExtensionSlot","type":"text","marks":[{"type":"code"}]},{"text":" renders a DOM tree of extensions bound to the slot, this hook simply returns the extensions as an array of React components that can be wired into a component however makes sense.","type":"text"}]},{"type":"paragraph","content":[{"text":"example","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"const extensions = useRenderableExtensions('my-extension-slot');\nreturn (\n <>\n {extensions.map((Ext, index) => (\n \n \n \n ))}\n \n)\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3305483a-f187-4699-ac48-ee2194f568a9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the extension slot","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"React.FC","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"Pick","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ExtensionProps","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"\"state\"","type":"text","marks":[{"type":"code"}]},{"text":">>[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useRenderableExtensions.tsx:31","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useRenderableExtensions.tsx#L31"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Feature Flags Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"getFeatureFlag","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getFeatureFlag","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"flagName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Use this function to access the current value of the feature flag","type":"text"}]},{"type":"paragraph","content":[{"text":"If you are using React, use ","type":"text"},{"text":"useFeatureFlag","type":"text","marks":[{"type":"code"}]},{"text":" instead.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"509ce3f2-59f2-4349-90d6-a366f73e2f91"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"flagName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-feature-flags/src/feature-flags.ts:71","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L71"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"registerFeatureFlag","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"registerFeatureFlag","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"flagName","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"label","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"description","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"This function creates a feature flag. Call it in top-level code anywhere. It will not reset whether the flag is enabled or not, so it's safe to call it multiple times. Once a feature flag is created, it will appear with a toggle in the Implementer Tools. It can then be used to turn on or off features in the code.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"208cb195-aa8c-4408-9a3f-7baf0ae120b9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"flagName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A code-friendly name for the flag, which will be used to reference it in code","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"label","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A human-friendly name which will be displayed in the Implementer Tools","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An explanation of what the flag does, which will be displayed in the Implementer Tools","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-feature-flags/src/feature-flags.ts:54","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L54"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useFeatureFlag","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useFeatureFlag","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"flagName","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Use this function to tell whether a feature flag is toggled on or off.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"import { useFeatureFlag } from \"@openmrs/esm-react-utils\";\n\nexport function MyComponent() {\n const isMyFeatureFlagOn = useFeatureFlag(\"my-feature-flag\");\n return <>{isMyFeatureFlagOn && };\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b0253f73-d605-4818-a1bb-0d46e90a5e56"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"flagName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useFeatureFlag.ts:19","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useFeatureFlag.ts#L19"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Framework Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"getAsyncExtensionLifecycle","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getAsyncExtensionLifecycle","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"lazy","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Use getAsyncLifecycle instead.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"147dd424-62ad-4819-bb73-1be09e4868e6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a653518e-4789-4cdf-a516-1feb0c04edcc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"lazy","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"() => ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<{ ","type":"text"},{"text":"default","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ComponentType","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"> }>","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentDecoratorOptions","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/getLifecycle.ts:32","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L32"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getAsyncLifecycle","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getAsyncLifecycle","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"lazy","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cf06fdc2-24a2-47b1-8b99-0b21cca681df"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c0626ea9-4c00-429c-9e4f-701d645a0d68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"lazy","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"() => ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<{ ","type":"text"},{"text":"default","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ComponentType","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"> }>","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentDecoratorOptions","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/getLifecycle.ts:18","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L18"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getLifecycle","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getLifecycle","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"Component","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"70e5c3d9-1e92-4da5-bfda-0fac8040b676"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"19b63ed9-9b47-460e-a72a-86eeae72c8dd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Component","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentType","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentDecoratorOptions","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"any","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/getLifecycle.ts:10","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L10"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getSyncLifecycle","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getSyncLifecycle","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"Component","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ca41ccde-bfbe-401b-a61a-ecac1e111faa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7f63f152-d8d0-41ef-bb12-dd88a53decec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Component","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentType","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ComponentDecoratorOptions","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/getLifecycle.ts:25","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L25"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Navigation Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ConfigurableLink","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"ConfigurableLink","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"__namedParameters","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Element","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"A React link component which calls ","type":"text"},{"text":"navigate","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/framework-api-reference#navigate"}}]},{"text":" when clicked","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ac0cee01-4d23-4c43-b0fd-cf1a002a0f82"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"__namedParameters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PropsWithChildren","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"ConfigurableLinkProps","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Element","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/ConfigurableLink.tsx:53","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L53"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getHistory","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getHistory","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of URLs representing the history of the current window session.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-navigation/src/history/history.ts:47","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/history/history.ts#L47"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"goBackInHistory","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"goBackInHistory","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"toUrl:","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Rolls back the history to the specified point and navigates to that URL.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"150dda39-543c-4bdc-a2f3-e29441a37649"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"toUrl:","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The URL in the history to navigate to. History after that index will be deleted. If the URL is not found in the history, an error will be thrown.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"toUrl:.toUrl","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-navigation/src/history/history.ts:58","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/history/history.ts#L58"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"interpolateString","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"interpolateString","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"template","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"params","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Interpolates values of ","type":"text"},{"text":"params","type":"text","marks":[{"type":"code"}]},{"text":" into the ","type":"text"},{"text":"template","type":"text","marks":[{"type":"code"}]},{"text":" string.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example usage:","type":"text"}]},{"type":"codeBlock","content":[{"text":"interpolateString(\"test ${one} ${two} 3\", {\n one: \"1\",\n two: \"2\",\n}); // will return \"test 1 2 3\"\ninterpolateString(\"test ok\", { one: \"1\", two: \"2\" }) // will return \"test ok\"\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cd9f8ea2-fc19-4ff3-b4c7-f82eaa831d10"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"template","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"With optional params wrapped in ","type":"text"},{"text":"${ }","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"params","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Values to interpolate into the string template","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-navigation/src/navigation/interpolate-string.ts:60","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L60"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"interpolateUrl","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"interpolateUrl","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"template","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"additionalParams?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Interpolates a string with openmrsBase and openmrsSpaBase.","type":"text"}]},{"type":"paragraph","content":[{"text":"Useful for accepting ","type":"text"},{"text":"${openmrsBase}","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"${openmrsSpaBase}","type":"text","marks":[{"type":"code"}]},{"text":"plus additional template parameters in configurable URLs.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example usage:","type":"text"}]},{"type":"codeBlock","content":[{"text":"interpolateUrl(\"test ${openmrsBase} ${openmrsSpaBase} ok\");\n // will return \"test /openmrs /openmrs/spa ok\"\n\ninterpolateUrl(\"${openmrsSpaBase}/patient/${patientUuid}\", {\n patientUuid: \"4fcb7185-c6c9-450f-8828-ccae9436bd82\",\n}); // will return \"/openmrs/spa/patient/4fcb7185-c6c9-450f-8828-ccae9436bd82\"\n","type":"text"}]},{"type":"paragraph","content":[{"text":"This can be used in conjunction with the ","type":"text"},{"text":"navigate","type":"text","marks":[{"type":"code"}]},{"text":" function like so","type":"text"}]},{"type":"codeBlock","content":[{"text":"navigate({\n to: interpolateUrl(\n \"${openmrsSpaBase}/patient/${patientUuid}\",\n { patientUuid: patient.uuid }\n )\n}); // will navigate to \"/openmrs/spa/patient/4fcb7185-c6c9-450f-8828-ccae9436bd82\"\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cc6ee333-9f42-446c-9797-c0f51f349482"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"template","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A string to interpolate","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"additionalParams?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Additional values to interpolate into the string template","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-navigation/src/navigation/interpolate-string.ts:36","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L36"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"navigate","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"navigate","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"to","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Calls ","type":"text"},{"text":"location.assign","type":"text","marks":[{"type":"code"}]},{"text":" for non-SPA paths and ","type":"text"},{"text":"navigateToUrl","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://single-spa.js.org/docs/api/#navigatetourl"}}]},{"text":" for SPA paths","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example usage:","type":"text"}]},{"type":"codeBlock","content":[{"text":"@example\nconst config = useConfig();\nconst submitHandler = () => {\n navigate({ to: config.links.submitSuccess });\n};\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example behavior::","type":"text"}]},{"type":"codeBlock","content":[{"text":"@example\nnavigate({ to: \"/some/path\" }); // => window.location.assign(\"/some/path\")\nnavigate({ to: \"https://single-spa.js.org/\" }); // => window.location.assign(\"https://single-spa.js.org/\")\nnavigate({ to: \"${openmrsBase}/some/path\" }); // => window.location.assign(\"/openmrs/some/path\")\nnavigate({ to: \"/openmrs/spa/foo/page\" }); // => navigateToUrl(\"/openmrs/spa/foo/page\")\nnavigate({ to: \"${openmrsSpaBase}/bar/page\" }); // => navigateToUrl(\"/openmrs/spa/bar/page\")\nnavigate({ to: \"/${openmrsSpaBase}/baz/page\" }) // => navigateToUrl(\"/openmrs/spa/baz/page\")\nnavigate({ to: \"https://o3.openmrs.org/${openmrsSpaBase}/qux/page\" }); // => navigateToUrl(\"/openmrs/spa/qux/page\")\n if `window.location.origin` == \"https://o3.openmrs.org\", else will use window.location.assign\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2397463d-eebc-48d6-be16-4ca8bbc9b207"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"to","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"NavigateOptions","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The target path or URL. Supports templating with 'openmrsBase', 'openmrsSpaBase', and any additional template parameters defined in ","type":"text"},{"text":"templateParams","type":"text","marks":[{"type":"code"}]},{"text":". For example, ","type":"text"},{"text":"${openmrsSpaBase}/home","type":"text","marks":[{"type":"code"}]},{"text":" will resolve to ","type":"text"},{"text":"/openmrs/spa/home","type":"text","marks":[{"type":"code"}]},{"text":" for implementations using the standard OpenMRS and SPA base paths. If ","type":"text"},{"text":"templateParams","type":"text","marks":[{"type":"code"}]},{"text":" contains ","type":"text"},{"text":"{ foo: \"bar\" }","type":"text","marks":[{"type":"code"}]},{"text":", then the URL ","type":"text"},{"text":"${openmrsBase}/${foo}","type":"text","marks":[{"type":"code"}]},{"text":" will become ","type":"text"},{"text":"/openmrs/bar","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-navigation/src/navigation/navigate.ts:49","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/navigate.ts#L49"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Offline Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"beginEditSynchronizationItem","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"beginEditSynchronizationItem","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers an edit flow for the given synchronization item. If this is not possible, throws an error.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c7c98c55-14cc-4241-b922-bb1ea4311943"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the synchronization item to be edited.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:330","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L330"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"canBeginEditSynchronizationItemsOfType","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"canBeginEditSynchronizationItemsOfType","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Returns whether editing synchronization items of the given type is supported by the currently registered synchronization handlers.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6e4d057e-a189-4818-a4fa-6cc4687045db"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization item which should be edited.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:320","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L320"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"deleteSynchronizationItem","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"deleteSynchronizationItem","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a queued up sync item with the given ID.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c9243af8-0b56-41c3-8a7a-2c63e3478e14"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the synchronization item to be deleted.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:350","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L350"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"generateOfflineUuid","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"generateOfflineUuid","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Generates a UUID-like string which is used for uniquely identifying objects while offline.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/uuid.ts:7","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L7"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getCurrentOfflineMode","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getCurrentOfflineMode","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"OfflineModeResult","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"OfflineModeResult","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/mode.ts:45","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L45"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getDynamicOfflineDataEntries","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getDynamicOfflineDataEntries","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"type?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" entries which registered for the currently logged in user. Optionally returns only entries of a given type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"64dfb2b1-9ca4-4293-8262-73357ef72498"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extends ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"48a1f086-bc40-474b-a2b7-d798f123b1aa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the entries to be returned. If ","type":"text"},{"text":"undefined","type":"text","marks":[{"type":"code"}]},{"text":", returns all types.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:128","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L128"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getDynamicOfflineDataEntriesFor","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getDynamicOfflineDataEntriesFor","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"userId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"type?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" entries which registered for the given user. Optionally returns only entries of a given type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c268ce2d-c0b2-4882-9fd8-9e4fc20201c7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"extends ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1c63f0c0-e973-4ee2-8bd5-d42564bedb0e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"userId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the user whose entries are to be retrieved.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the entries to be returned. If ","type":"text"},{"text":"undefined","type":"text","marks":[{"type":"code"}]},{"text":", returns all types.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:139","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L139"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getDynamicOfflineDataHandlers","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getDynamicOfflineDataHandlers","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"DynamicOfflineDataHandler","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all handlers which have been setup using the ","type":"text"},{"text":"setupDynamicOfflineDataHandler","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/framework-api-reference#setupdynamicofflinedatahandler"}}]},{"text":" function.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"DynamicOfflineDataHandler","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:104","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L104"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getFullSynchronizationItems","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getFullSynchronizationItems","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"type?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">[]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all currently queued up sync items of the currently signed in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"70dd77b4-9369-49e5-a1fb-a8fde4dd4e5f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2d1354b9-b381-4b3f-b519-1e74d8ed12a4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization items to be returned.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">[]>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:302","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L302"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getFullSynchronizationItemsFor","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getFullSynchronizationItemsFor","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"userId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"type?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">[]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all currently queued up sync items of a given user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"80796579-9075-47df-8bbc-9c65cd9e1ca2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"79558a65-b6e8-41e2-9966-c80c05eda973"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"userId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the user whose synchronization items should be returned.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization items to be returned..","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">[]>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:281","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L281"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getOfflinePatientDataStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getOfflinePatientDataStore","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"OfflinePatientDataSyncStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Will be removed once all modules have been migrated to the new dynamic offline data API.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"OfflinePatientDataSyncStore","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/offline-patient-data.ts:39","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L39"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getSynchronizationItem","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getSynchronizationItem","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"> | ","type":"text"},{"text":"undefined","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a queued sync item with the given ID or ","type":"text"},{"text":"undefined","type":"text","marks":[{"type":"code"}]},{"text":" if no such item exists.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"dee0d605-7ebc-4663-91c2-5981d99259a6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"any","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"57bc6e92-d6c9-4b3e-ad12-4cb73a2e265d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the requested sync item.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"SyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"> | ","type":"text"},{"text":"undefined","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:311","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L311"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getSynchronizationItems","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getSynchronizationItems","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"type?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the content of all currently queued up sync items of the currently signed in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"12b5bb03-65c9-4997-87e8-7a5df7710c8f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9dc9738b-a0ce-47da-ba3e-43ba2564fd5b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization items to be returned.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"[]>","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:293","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L293"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"isOfflineUuid","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"isOfflineUuid","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"uuid","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Checks whether the given string has the format of an offline UUID generated by ","type":"text"},{"text":"generateOfflineUuid","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/framework-api-reference#generateofflineuuid"}}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4a12d1cd-b2b8-4591-8c49-45c1e5eed90e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"uuid","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/uuid.ts:12","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L12"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"messageOmrsServiceWorker","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"messageOmrsServiceWorker","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"MessageServiceWorkerResult","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">>","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends the specified message to the application's service worker.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"40f1627e-186f-43e4-b161-4f124251cbfd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"message","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"KnownOmrsServiceWorkerMessages","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The message to be sent.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"MessageServiceWorkerResult","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":">>","type":"text"}]},{"type":"paragraph","content":[{"text":"A promise which completes when the message has been successfully processed by the Service Worker.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/service-worker-messaging.ts:11","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L11"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"putDynamicOfflineData","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"putDynamicOfflineData","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Declares that dynamic offline data of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" with the given ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FHIRResource.md#identifier"}}]},{"text":" should be made available offline for the currently logged in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"29560635-db11-43eb-8e8e-804794f437dd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:157","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L157"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"putDynamicOfflineDataFor","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"putDynamicOfflineDataFor","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"userId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Declares that dynamic offline data of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" with the given ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FHIRResource.md#identifier"}}]},{"text":" should be made available offline for the user with the given ID.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"fd71ecba-0202-4ba6-a6dc-49a10e333642"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"userId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the user for whom the dynamic offline data should be made available.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:169","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L169"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"queueSynchronizationItem","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"queueSynchronizationItem","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"content","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"descriptor?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Enqueues a new item in the sync queue and associates the item with the currently signed in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4b8a5f85-052b-4a82-bfe5-61e6978d990f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8ed0571e-d656-47a5-b289-66bc9ef587d4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization item.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"content","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The actual data to be synchronized.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"descriptor?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"QueueItemDescriptor","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An optional descriptor providing additional metadata about the sync item.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:261","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L261"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"registerOfflinePatientHandler","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"registerOfflinePatientHandler","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"handler","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Will be removed once all modules have been migrated to the new dynamic offline data API.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6b10f918-9407-4abf-91a5-3608f2a2a44d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"handler","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"OfflinePatientDataSyncHandler","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/offline-patient-data.ts:45","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"removeDynamicOfflineData","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"removeDynamicOfflineData","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Declares that dynamic offline data of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" with the given ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FHIRResource.md#identifier"}}]},{"text":" no longer needs to be available offline for the currently logged in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"082465d7-4adf-497c-b523-93964ab6674a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:201","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L201"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"removeDynamicOfflineDataFor","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"removeDynamicOfflineDataFor","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"userId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Declares that dynamic offline data of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" with the given ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FHIRResource.md#identifier"}}]},{"text":" no longer needs to be available offline for the user with the given ID.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2775480b-8000-4b65-b096-547338f50a4e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"userId","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The ID of the user who doesn't require the specified offline data.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:213","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setupDynamicOfflineDataHandler","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"setupDynamicOfflineDataHandler","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"handler","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Sets up a handler for synchronizing dynamic offline data. See ","type":"text"},{"text":"DynamicOfflineDataHandler","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineDataHandler.md"}}]},{"text":" for details.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ab2a2ee9-093a-47eb-84e9-5b390044d6d4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"handler","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DynamicOfflineDataHandler","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The handler to be setup.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:113","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L113"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setupOfflineSync","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"setupOfflineSync","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"dependsOn","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"process","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"options?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Registers a new synchronization handler which is able to synchronize data of a specific type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0709753c-d700-4d6a-8e3b-6d20f3b9840a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e55e86b3-b126-4297-9d9b-66513d48b721"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifying type of the synchronization items which can be handled by this handler.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"dependsOn","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"[]","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An array of other sync item types which must be synchronized before this handler can synchronize its own data. Items of these types are effectively dependencies of the data synchronized by this handler.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"process","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ProcessSyncItem","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A function which, when invoked, performs the actual client-server synchronization of the given ","type":"text"},{"text":"item","type":"text","marks":[{"type":"code"}]},{"text":" (which is the actual data to be synchronized).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"SetupOfflineSyncOptions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Additional options which can optionally be provided when setting up a synchronization callback for a specific synchronization item type.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/sync.ts:365","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L365"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"subscribeConnectivity","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"subscribeConnectivity","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"cb","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"dd43d1b9-0bdb-4aef-8b79-46edfe783a7c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"cb","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"ev","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ConnectivityChangedEvent","type":"text","marks":[{"type":"code"}]},{"text":") => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-globals/src/events.ts:23","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L23"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"subscribeConnectivityChanged","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"subscribeConnectivityChanged","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"cb","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"71e175b1-f9b8-4a59-8757-21cf9e56cb63"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"cb","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"ev","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ConnectivityChangedEvent","type":"text","marks":[{"type":"code"}]},{"text":") => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-globals/src/events.ts:12","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L12"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"subscribePrecacheStaticDependencies","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"subscribePrecacheStaticDependencies","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"cb","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d61750d6-245c-4328-9a62-6f939e7efe5b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"cb","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"data","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"PrecacheStaticDependenciesEvent","type":"text","marks":[{"type":"code"}]},{"text":") => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-globals/src/events.ts:37","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L37"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"syncAllDynamicOfflineData","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"syncAllDynamicOfflineData","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"abortSignal?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Synchronizes all offline data entries of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" for the currently logged in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7c811e7a-553d-4d48-98d1-961212fa1298"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"abortSignal?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AbortSignal","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An {","type":"text"},{"text":"@link","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"link","attrs":{"href":"https://github.com/link"}}]},{"text":" AbortSignal} which can be used to cancel the operation.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:241","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L241"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"syncDynamicOfflineData","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"syncDynamicOfflineData","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"identifier","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"abortSignal?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Synchronizes a single offline data entry of the given ","type":"text"},{"text":"type","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/FetchResponse.md#type"}}]},{"text":" for the currently logged in user.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9cfc5177-52af-4936-ba53-0d094c8e5b42"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The type of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"identifier","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The identifier of the offline data. See ","type":"text"},{"text":"DynamicOfflineData","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/interfaces/DynamicOfflineData.md"}}]},{"text":" for details.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"abortSignal?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"AbortSignal","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An {","type":"text"},{"text":"@link","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"link","attrs":{"href":"https://github.com/link"}}]},{"text":" AbortSignal} which can be used to cancel the operation.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/dynamic-offline-data.ts:254","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L254"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"syncOfflinePatientData","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"syncOfflinePatientData","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"patientUuid","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"deprecated","type":"text","marks":[{"type":"code"}]},{"text":" Will be removed once all modules have been migrated to the new dynamic offline data API.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"faae4706-7c7f-4026-82ae-2d3b7cf68b9d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"patientUuid","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Promise","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-offline/src/offline-patient-data.ts:62","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L62"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useConnectivity","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useConnectivity","type":"text","marks":[{"type":"strong"}]},{"text":"(): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useConnectivity.ts:6","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectivity.ts#L6"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Other Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"WorkspaceContainer","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"WorkspaceContainer","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"__namedParameters","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"Element","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Use this component to render the ","type":"text"},{"text":"workspace window","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://zeroheight.com/23a080e38/p/483a22-workspace"}}]},{"text":" in an app such as the patient chart, or a workspace overlay in an app such as the clinic dashboard. This allows workspaces to be opened on the page where this component is mounted. This component must not be mounted multiple times on the same page. If there are multiple apps on a page, only one of those apps should use this component—it \"hosts\" the workspaces.","type":"text"}]},{"type":"paragraph","content":[{"text":"Workspaces may be opened with the ","type":"text"},{"text":"launchWorkspace","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://o3-docs.openmrs.org/docs/framework-api-reference#launchworkspace"}}]},{"text":" function from ","type":"text"},{"text":"@openmrs/esm-framework","type":"text","marks":[{"type":"code"}]},{"text":" (among other options).","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"overlay","type":"text","marks":[{"type":"code"}]},{"text":" prop determines whether the workspace is rendered as an overlay or a window. When a workspace window is opened, the other content on the screen will be pushed to the left. When an overlay is opened, it will cover other content on the screen.","type":"text"}]},{"type":"paragraph","content":[{"text":"The context key is a string that appears in the URL, which defines the pages on which workspaces are valid. If the URL changes in a way such that it no longer contains the context key, then all workspaces will be closed. This ensures that, for example, workspaces on the home page do not stay open when the user transitions to the patient dashboard; and also that workspaces do not stay open when the user navigates to a different patient. The context key must be a valid sub-path of the URL, with no initial or trailing slash. So if the URL is ","type":"text"},{"text":"https://example.com/patient/123/foo","type":"text","marks":[{"type":"code"}]},{"text":", then ","type":"text"},{"text":"patient","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"patient/123","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"123/foo","type":"text","marks":[{"type":"code"}]},{"text":" are valid context keys, but ","type":"text"},{"text":"patient/12","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"pati","type":"text","marks":[{"type":"code"}]},{"text":" are not.","type":"text"}]},{"type":"paragraph","content":[{"text":"An extension slot is provided in the workspace header. Its name is derived from the ","type":"text"},{"text":"featureName","type":"text","marks":[{"type":"code"}]},{"text":" of the top-level component in which it is defined (feature names are generally provided in the lifecycle functions in an app's ","type":"text"},{"text":"index.ts","type":"text","marks":[{"type":"code"}]},{"text":" file). The slot is named ","type":"text"},{"text":"workspace-header-${featureName}-slot","type":"text","marks":[{"type":"code"}]},{"text":". For the patient chart, this is ","type":"text"},{"text":"workspace-header-patient-chart-slot","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"This component also provides the ","type":"text"},{"text":"Siderail and Bottom Nav","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://zeroheight.com/23a080e38/p/948cf1-siderail-and-bottom-nav/b/86907e"}}]},{"text":". To use this, pass the ","type":"text"},{"text":"showSiderailAndBottomNav","type":"text","marks":[{"type":"code"}]},{"text":" prop. The Siderail is rendered on the right side of the screen on desktop, and the Bottom Nav is rendered at the bottom of the screen on tablet or mobile. The sidebar/bottom-nav menu provides an extension slot, to which buttons are attached as extensions. The slot derives its name from the ","type":"text"},{"text":"featureName","type":"text","marks":[{"type":"code"}]},{"text":" of the top-level component in which this ","type":"text"},{"text":"WorkspaceContainer","type":"text","marks":[{"type":"code"}]},{"text":" appears (feature names are generally provided in the lifecycle functions in an app's ","type":"text"},{"text":"index.ts","type":"text","marks":[{"type":"code"}]},{"text":" file). The slot is named ","type":"text"},{"text":"action-menu-${featureName}-items-slot","type":"text","marks":[{"type":"code"}]},{"text":". For the patient chart, this is ","type":"text"},{"text":"action-menu-patient-chart-items-slot","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"This component also provides everything needed for workspace notifications to be rendered.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"483e5699-0ece-497e-b3a6-aa91dcf8bb40"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"__namedParameters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"WorkspaceContainerProps","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"Element","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:67","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L67"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"isOnline","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"isOnline","type":"text","marks":[{"type":"strong"}]},{"text":"(","type":"text"},{"text":"online?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d9007ca3-4ebd-4d27-b595-2e5742273718"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"online?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-utils/src/is-online.ts:3","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/is-online.ts#L3"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Store Functions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"createGlobalStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"createGlobalStore","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"initialState","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a Zustand store.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8c02d0b5-716c-4579-9c6b-6532ef04cb88"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"65c4c600-4637-4486-8e56-18f4f6eb69a1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A name by which the store can be looked up later. Must be unique across the entire application.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"initialState","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An object which will be the initial state of the store.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"The newly created store.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-state/src/state.ts:29","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L29"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"createUseStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"createUseStore","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"store","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":"(","type":"text"},{"text":"actions","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">) => ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]},{"text":"(","type":"text"},{"text":"actions?","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">) => ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Whenever possible, use ","type":"text"},{"text":"useStore(yourStore)","type":"text","marks":[{"type":"code"}]},{"text":" instead. This function is for creating a custom hook for a specific store.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cb8ca992-e9ac-4c87-bacb-c03fe33c0b27"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b4aa4fb5-039d-448e-8ae0-ccb8bd040362"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"store","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (","type":"text"},{"text":"actions","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9d221918-1f93-422d-9b1c-7763897cf5eb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"actions","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (","type":"text"},{"text":"actions?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ccf20220-d858-47b7-880a-6c146094f8b7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"actions?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Actions","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":" & ","type":"text"},{"text":"BoundActions","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-react-utils/src/useStore.ts:60","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L60"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getGlobalStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"getGlobalStore","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"fallbackState?","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the existing store named ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":", or creates a new store named ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" if none exists.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"57dc2346-8515-4caa-b77a-438c42aaed64"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f1d23aa5-e1be-4f2c-b744-69cca99085d5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The name of the store to look up.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"fallbackState?","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The initial value of the new store if no store named ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" exists.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]},{"type":"paragraph","content":[{"text":"The found or newly created store.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-state/src/state.ts:91","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L91"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"subscribeTo","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"subscribeTo","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"U","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"store","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"select","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"handle","type":"text","marks":[{"type":"code"}]},{"text":"): () => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6c287d1c-bd71-4a32-bcb6-c2065e4098c9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"U","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e4f4344f-a967-404e-819f-22733b421ed8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"store","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"StoreApi","type":"text","marks":[{"type":"code"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":">","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"select","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"state","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":") => ","type":"text"},{"text":"U","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"handle","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"subState","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"U","type":"text","marks":[{"type":"code"}]},{"text":") => ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"fn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"▸ (): ","type":"text"},{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"void","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Defined in","type":"text"}]},{"type":"paragraph","content":[{"text":"packages/framework/esm-state/src/state.ts:106","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L106"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"useStore","type":"text"}]},{"type":"paragraph","content":[{"text":"▸ ","type":"text"},{"text":"useStore","type":"text","marks":[{"type":"strong"}]},{"text":"<","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"U","type":"text","marks":[{"type":"code"}]},{"text":">(","type":"text"},{"text":"store","type":"text","marks":[{"type":"code"}]},{"text":"): ","type":"text"},{"text":"T","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Type parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0ddfa98a-cf5d-4733-ae06-414a0d1e660e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"T","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"U","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"94389bcc-e686-45de-bd71-74df5fd13726"}

Browser not supported