ICopilotContext
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Host facts used to resolve events, never application services.
export interface ICopilotContext<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| ICopilotTarget<TBuild> | (ALPHA) (Optional) Object being displayed in a builder, if any. | |
| boolean | (ALPHA) (Optional) Whether the host allows edits to the displayed object. | |
| string | (ALPHA) (Optional) Currently displayed object. | |
| TBuild | (ALPHA) (Optional) Currently displayed workflow. |
Property details
ICopilotContext.builderTargetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Object being displayed in a builder, if any.
readonly builderTarget?: ICopilotTarget<TBuild>;
ICopilotContext.isEditingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the host allows edits to the displayed object.
readonly isEditing?: boolean;
ICopilotContext.objectIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Currently displayed object.
readonly objectId?: string;
ICopilotContext.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Currently displayed workflow.
readonly type?: TBuild;