Type Alias: ControlPlaneHooks
Generated from SDK v1 (protocol 1) at source revision
97c6bb1. Never edit by hand; runnpm run generate:reference.
Type Alias: ControlPlaneHooks
Section titled “Type Alias: ControlPlaneHooks”ControlPlaneHooks =
object
Defined in: sdk/react.ts:28
Properties
Section titled “Properties”useAnswerInteraction()
Section titled “useAnswerInteraction()”useAnswerInteraction: (
interactionId,answer) =>ControlPlaneAnswerResult|undefined
Defined in: sdk/react.ts:38
Parameters
Section titled “Parameters”interactionId
Section titled “interactionId”string
answer
Section titled “answer”Returns
Section titled “Returns”ControlPlaneAnswerResult | undefined
useArtifacts()
Section titled “useArtifacts()”useArtifacts: (
workItemId) => readonlyControlPlaneArtifact[] |undefined
Defined in: sdk/react.ts:35
Parameters
Section titled “Parameters”workItemId
Section titled “workItemId”string
Returns
Section titled “Returns”readonly ControlPlaneArtifact[] | undefined
useBoard()
Section titled “useBoard()”useBoard: () => readonly
ControlPlaneBoardItem[] |undefined
Defined in: sdk/react.ts:29
Returns
Section titled “Returns”readonly ControlPlaneBoardItem[] | undefined
useCommand()
Section titled “useCommand()”useCommand: (
command) =>ControlPlaneCommandResult|undefined
Defined in: sdk/react.ts:37
Parameters
Section titled “Parameters”command
Section titled “command”Returns
Section titled “Returns”ControlPlaneCommandResult | undefined
useEvents()
Section titled “useEvents()”useEvents: (
afterSequence?) => readonlyControlPlaneEvent[] |undefined
Defined in: sdk/react.ts:33
Parameters
Section titled “Parameters”afterSequence?
Section titled “afterSequence?”number
Returns
Section titled “Returns”readonly ControlPlaneEvent[] | undefined
useEventStream()
Section titled “useEventStream()”useEventStream: (
afterSequence?) => readonlyControlPlaneEvent[]
Defined in: sdk/react.ts:34
Parameters
Section titled “Parameters”afterSequence?
Section titled “afterSequence?”number
Returns
Section titled “Returns”readonly ControlPlaneEvent[]
useInteractions()
Section titled “useInteractions()”useInteractions: () => readonly
ControlPlaneInteraction[] |undefined
Defined in: sdk/react.ts:32
Returns
Section titled “Returns”readonly ControlPlaneInteraction[] | undefined
useOpenInteractions()
Section titled “useOpenInteractions()”useOpenInteractions: () => readonly
ControlPlaneInteraction[] |undefined
Defined in: sdk/react.ts:31
Returns
Section titled “Returns”readonly ControlPlaneInteraction[] | undefined
useProjection()
Section titled “useProjection()”useProjection: <
T>(events,initial,reduce) =>T
Defined in: sdk/react.ts:42
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”events
Section titled “events”readonly ControlPlaneEvent[]
initial
Section titled “initial”T
reduce
Section titled “reduce”(state, event) => T
Returns
Section titled “Returns”T
useRevisions()
Section titled “useRevisions()”useRevisions: () => readonly
ControlPlaneRevision[] |undefined
Defined in: sdk/react.ts:36
Returns
Section titled “Returns”readonly ControlPlaneRevision[] | undefined
useTask()
Section titled “useTask()”useTask: (
workItemId) =>ControlPlaneTask|undefined
Defined in: sdk/react.ts:30
Parameters
Section titled “Parameters”workItemId
Section titled “workItemId”string
Returns
Section titled “Returns”ControlPlaneTask | undefined