UIInteractionContextValue

UIInteractionContextValue = object

Defined in: src/react/useUIInteraction.ts:39

Context value for UI interactions

Properties

cancelInteraction()

cancelInteraction: (id: string) => void

Defined in: src/react/useUIInteraction.ts:51

Parameters

Parameter	Type
`id`	`string`

Returns

void

clearInteractions()

clearInteractions: () => void

Defined in: src/react/useUIInteraction.ts:52

Returns

void

createDisplayInteraction()

createDisplayInteraction: (id: string, displayType: string, data: unknown, result: unknown, toolVersion?: number, replacesInteractionId?: string) => void

Defined in: src/react/useUIInteraction.ts:42

Parameters

Parameter	Type
`id`	`string`
`displayType`	`string`
`data`	`unknown`
`result`	`unknown`
`toolVersion?`	`number`
`replacesInteractionId?`	`string`

Returns

void

createInteraction()

createInteraction: (id: string, type: InteractionType, data: unknown) => Promise<unknown>

Defined in: src/react/useUIInteraction.ts:41

Parameters

Parameter	Type
`id`	`string`
`type`	`InteractionType`
`data`	`unknown`

Returns

Promise<unknown>

getInteraction()

getInteraction: (id: string) => PendingInteraction | undefined

Defined in: src/react/useUIInteraction.ts:53

Parameters

Parameter	Type
`id`	`string`

Returns

PendingInteraction | undefined

pendingInteractions

pendingInteractions: Map<string, PendingInteraction>

Defined in: src/react/useUIInteraction.ts:40

resolveInteraction()

resolveInteraction: (id: string, result: unknown) => void

Defined in: src/react/useUIInteraction.ts:50

Parameters

Parameter	Type
`id`	`string`
`result`	`unknown`

Returns

void