Home > @uniformdev/mesh-sdk > UniformMeshSDK
UniformMeshSDK interface
Signature:
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| closeLocationDialog | (options: CloseLocationDialogOptions) => Promise<void> | Explicitly close a location dialog. Called within the dialog. | |
| currentWindow | SdkWindow | undefined | The current <code>window</code> object being used for the SDK | |
| events | Emitter<UniformMeshSDKEvents> | ||
| getCurrentLocation | <TValue = unknown, TSetValue = unknown>() => MeshLocation<TValue, TSetValue> | Gets the current location that the Mesh App is being displayed on. | |
| openLocationDialog | <TExpectedDialogResult = unknown, TDialogParams = void>(options: OpenLocationDialogOptions<TExpectedDialogResult> | undefined> | Opens a dialog in the Uniform app with the URL set to a specific named dialog registered for the current location in the Mesh app manifest | |
| version | string | The version of the Mesh framework being used |
Methods
| Method | Description |
|---|---|
| closeCurrentLocationDialog() | Explicitly close a location dialog. Called when rendering current location in the dialog. |
| openConfirmationDialog(options) | Opens a confirmation dialog to get a confirm/cancel question answered. Does not require any registration with the Mesh app manifest. |
| openCurrentLocationDialog(options) | Opens the current location within a dialog, enabling to to break out of the layout it was loaded in. |