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