Home > @uniformdev/mesh-sdk

mesh-sdk package

Classes

ClassDescription
IntegrationDefinitionClientAPI Client to manage the registration of custom Mesh applications
IntegrationInstallationClientAPI Client to manage the registration of custom Mesh applications

Functions

FunctionDescription
initializeUniformMeshSDK({ autoResizingDisabled, })Initializes the Uniform Mesh SDK. Intended to be called (and awaited) prior to any attempted interaction with the Uniform Mesh SDK.

Interfaces

InterfaceDescription
DialogContext
DialogOptions
DialogResponseData
DialogResponseHandler
DialogResponseHandlers
LocationDialogResponse
MeshContextData
MeshLocationCoreCore shared generic for a mesh location context
SdkWindow
UniformMeshSDK

Variables

VariableDescription
hasPermissions
hasRoleCheck if user has a role by both name and id

Type Aliases

Type AliasDescription
AIGenerateLocation
AIGenerateLocationMetadata
AIPromptMetadataLocation
AssetLibraryLocation
AssetLibraryLocationMetadata
AssetParameterLocation
AssetParameterLocationMetadata
BindableTypesPrimitive data types that a parameter type accepts to be bound to composition data
CloseDialogMessage
CloseLocationDialogOptions
CommonMetadataCommon metadata for all mesh locations
CSSHeight
DataConnectorInfo
DataResourceLocation
DataResourceLocationMetadata
DataSourceLocation
DataSourceLocationMetadata
DataSourceLocationValue
DataTypeLocation
DataTypeLocationMetadata
DataTypeLocationValue
DialogParams
DialogParamValue
DialogType
DynamicInput<p>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).</p><p>Dynamic inputs only work at runtime when using the route endpoint to fetch data.</p>
DynamicInputsRecord of dynamic inputs keyed by the input name
EditConnectedDataMessageMessage to parent to create a data connection expression to insert in a param type
EditConnectedDataResponseResponse from parent when creating a dynamic token expression
EditConnectedDataResponseCancellationContext
GetDataResourceLocation
GetDataResourceMessage
IntegrationDefinitionDeleteParametersThe DELETE body for /api/v1/integration-definitions
IntegrationDefinitionGetParametersQuery parameter options for GET /api/v1/integration-definitions
IntegrationDefinitionGetResponseThe GET response from /api/v1/integration-definitions
IntegrationDefinitionPutParametersThe PUT body for /api/v1/integration-definitions
IntegrationDefinitionPutResponseThe PUT response body for /api/v1/integration-definitions (has team-specific integration type)
IntegrationInstallationDeleteParametersThe DELETE body for /api/v1/integration-installations
IntegrationInstallationGetParametersQuery parameter options for GET /api/v1/integration-installations
IntegrationInstallationGetResponseThe GET response from /api/v1/integration-installations
IntegrationInstallationPutParametersThe PUT body for /api/v1/integration-installations
MeshLocationDefines methods used for interacting with a Mesh location To receive useful typings, check the <code>type</code> property of the location to narrow the typing.
MeshLocationTypesKnown location types that can be passed to a mesh location
MeshLocationUserPermissions
MeshSDKEventInterface
OpenConfirmationDialogOptions
OpenConfirmationDialogResult
OpenDialogMessage
OpenDialogResult
OpenLocationDialogOptions
ParamTypeConfigLocation
ParamTypeConfigLocationMetadata
ParamTypeLocation
ParamTypeLocationMetadata
PromptSettingsLocationMetadata
SetLocationFunction
SettingsLocation
SettingsLocationMetadata
SetValueMessage
SetValueOptions
UniformMeshSDKEventsEvents that can be emitted from the Mesh SDK
UniformUser
ValidationResult