Home > @uniformdev/mesh-sdk

mesh-sdk package

Classes

<table><thead><tr><th>

Class

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

IntegrationDefinitionClient

</td><td>

API Client to manage the registration of custom Mesh applications

</td></tr> <tr><td>

IntegrationInstallationClient

</td><td>

API Client to manage the registration of custom Mesh applications

</td></tr> </tbody></table>

Functions

<table><thead><tr><th>

Function

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

initializeUniformMeshSDK({ autoResizingDisabled, })

</td><td>

Initializes the Uniform Mesh SDK. Intended to be called (and awaited) prior to any attempted interaction with the Uniform Mesh SDK.

</td></tr> </tbody></table>

Interfaces

<table><thead><tr><th>

Interface

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

DialogContext

</td><td>

</td></tr> <tr><td>

DialogOptions

</td><td>

</td></tr> <tr><td>

DialogResponseData

</td><td>

</td></tr> <tr><td>

DialogResponseHandler

</td><td>

</td></tr> <tr><td>

DialogResponseHandlers

</td><td>

</td></tr> <tr><td>

LocationDialogResponse

</td><td>

</td></tr> <tr><td>

MeshContextData

</td><td>

</td></tr> <tr><td>

MeshLocationCore

</td><td>

Core shared generic for a mesh location context

</td></tr> <tr><td>

SdkWindow

</td><td>

</td></tr> <tr><td>

UniformMeshSDK

</td><td>

</td></tr> </tbody></table>

Variables

<table><thead><tr><th>

Variable

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

hasPermissions

</td><td>

</td></tr> <tr><td>

hasRole

</td><td>

Check if user has a role by both name and id

</td></tr> </tbody></table>

Type Aliases

<table><thead><tr><th>

Type Alias

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

AIGenerateLocation

</td><td>

</td></tr> <tr><td>

AIGenerateLocationMetadata

</td><td>

</td></tr> <tr><td>

AIPromptMetadataLocation

</td><td>

</td></tr> <tr><td>

AssetLibraryLocation

</td><td>

</td></tr> <tr><td>

AssetLibraryLocationMetadata

</td><td>

</td></tr> <tr><td>

AssetParameterLocation

</td><td>

</td></tr> <tr><td>

AssetParameterLocationMetadata

</td><td>

</td></tr> <tr><td>

BindableTypes

</td><td>

Primitive data types that a parameter type accepts to be bound to composition data

</td></tr> <tr><td>

CloseDialogMessage

</td><td>

</td></tr> <tr><td>

CloseLocationDialogOptions

</td><td>

</td></tr> <tr><td>

CommonMetadata

</td><td>

Common metadata for all mesh locations

</td></tr> <tr><td>

CSSHeight

</td><td>

</td></tr> <tr><td>

DataConnectorInfo

</td><td>

</td></tr> <tr><td>

DataResourceLocation

</td><td>

</td></tr> <tr><td>

DataResourceLocationMetadata

</td><td>

</td></tr> <tr><td>

DataSourceLocation

</td><td>

</td></tr> <tr><td>

DataSourceLocationMetadata

</td><td>

</td></tr> <tr><td>

DataSourceLocationValue

</td><td>

</td></tr> <tr><td>

DataTypeLocation

</td><td>

</td></tr> <tr><td>

DataTypeLocationMetadata

</td><td>

</td></tr> <tr><td>

DataTypeLocationValue

</td><td>

</td></tr> <tr><td>

DialogParams

</td><td>

</td></tr> <tr><td>

DialogParamValue

</td><td>

</td></tr> <tr><td>

DialogType

</td><td>

</td></tr> <tr><td>

DynamicInput

</td><td>

Dynamic inputs come from project map and represent path or query based dynamic values These can be connected to from within a Mesh location by setting a data resource variable to contain ex: $} expression(s).

Dynamic inputs only work at runtime when using the route endpoint to fetch data.

</td></tr> <tr><td>

DynamicInputs

</td><td>

Record of dynamic inputs keyed by the input name

</td></tr> <tr><td>

EditConnectedDataMessage

</td><td>

Message to parent to create a data connection expression to insert in a param type

</td></tr> <tr><td>

EditConnectedDataResponse

</td><td>

Response from parent when creating a dynamic token expression

</td></tr> <tr><td>

EditConnectedDataResponseCancellationContext

</td><td>

</td></tr> <tr><td>

GetDataResourceLocation

</td><td>

</td></tr> <tr><td>

GetDataResourceMessage

</td><td>

</td></tr> <tr><td>

IntegrationDefinitionDeleteParameters

</td><td>

The DELETE body for /api/v1/integration-definitions

</td></tr> <tr><td>

IntegrationDefinitionGetParameters

</td><td>

Query parameter options for GET /api/v1/integration-definitions

</td></tr> <tr><td>

IntegrationDefinitionGetResponse

</td><td>

The GET response from /api/v1/integration-definitions

</td></tr> <tr><td>

IntegrationDefinitionPutParameters

</td><td>

The PUT body for /api/v1/integration-definitions

</td></tr> <tr><td>

IntegrationDefinitionPutResponse

</td><td>

The PUT response body for /api/v1/integration-definitions (has team-specific integration type)

</td></tr> <tr><td>

IntegrationInstallationDeleteParameters

</td><td>

The DELETE body for /api/v1/integration-installations

</td></tr> <tr><td>

IntegrationInstallationGetParameters

</td><td>

Query parameter options for GET /api/v1/integration-installations

</td></tr> <tr><td>

IntegrationInstallationGetResponse

</td><td>

The GET response from /api/v1/integration-installations

</td></tr> <tr><td>

IntegrationInstallationPutParameters

</td><td>

The PUT body for /api/v1/integration-installations

</td></tr> <tr><td>

MeshLocation

</td><td>

Defines methods used for interacting with a Mesh location To receive useful typings, check the type property of the location to narrow the typing.

</td></tr> <tr><td>

MeshLocationTypes

</td><td>

Known location types that can be passed to a mesh location

</td></tr> <tr><td>

MeshLocationUserPermissions

</td><td>

</td></tr> <tr><td>

MeshSDKEventInterface

</td><td>

</td></tr> <tr><td>

OpenConfirmationDialogOptions

</td><td>

</td></tr> <tr><td>

OpenConfirmationDialogResult

</td><td>

</td></tr> <tr><td>

OpenDialogMessage

</td><td>

</td></tr> <tr><td>

OpenDialogResult

</td><td>

</td></tr> <tr><td>

OpenLocationDialogOptions

</td><td>

</td></tr> <tr><td>

ParamTypeConfigLocation

</td><td>

</td></tr> <tr><td>

ParamTypeConfigLocationMetadata

</td><td>

</td></tr> <tr><td>

ParamTypeLocation

</td><td>

</td></tr> <tr><td>

ParamTypeLocationMetadata

</td><td>

</td></tr> <tr><td>

PromptSettingsLocationMetadata

</td><td>

</td></tr> <tr><td>

SetLocationFunction

</td><td>

</td></tr> <tr><td>

SettingsLocation

</td><td>

</td></tr> <tr><td>

SettingsLocationMetadata

</td><td>

</td></tr> <tr><td>

SetValueMessage

</td><td>

</td></tr> <tr><td>

SetValueOptions

</td><td>

</td></tr> <tr><td>

UniformMeshSDKEvents

</td><td>

Events that can be emitted from the Mesh SDK

</td></tr> <tr><td>

UniformUser

</td><td>

</td></tr> <tr><td>

ValidationResult

</td><td>

</td></tr> </tbody></table>