ICopilotRegistration
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Pure definition target resolver and host effect for one workflow.
export interface ICopilotRegistration<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (event: ChatDefinitionReceivedEvent, applicationId: string, target: ICopilotTarget<TBuild>) => void | (ALPHA) Apply the accepted definition, then explicitly acknowledge its application ID. | |
| (event: ChatDefinitionReceivedEvent, context: ICopilotContext<TBuild>, snapshot: ICopilotSnapshot<TBuild>) => ICopilotTarget<TBuild> | undefined | (ALPHA) Resolve a definition’s target; return undefined for unsupported definitions. The handler applies matching builder definitions, or live definitions for pending generation, the builder’s applied conversation, or the currently edited object. | |
| readonly AgentCustomSkill[] | (ALPHA) Skills that activate this workflow. | |
| TBuild | (ALPHA) Workflow activated by these skills. |
Property details
ICopilotRegistration.onApplyDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Apply the accepted definition, then explicitly acknowledge its application ID.
readonly onApplyDefinition: (event: ChatDefinitionReceivedEvent, applicationId: string, target: ICopilotTarget<TBuild>) => void;
ICopilotRegistration.resolveDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Resolve a definition’s target; return undefined for unsupported definitions. The handler applies matching builder definitions, or live definitions for pending generation, the builder’s applied conversation, or the currently edited object.
readonly resolveDefinition: (event: ChatDefinitionReceivedEvent, context: ICopilotContext<TBuild>, snapshot: ICopilotSnapshot<TBuild>) => ICopilotTarget<TBuild> | undefined;
ICopilotRegistration.skillspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Skills that activate this workflow.
readonly skills: readonly AgentCustomSkill[];
ICopilotRegistration.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workflow activated by these skills.
readonly type: TBuild;