ICopilotScope
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Scope of a progress query.
export interface ICopilotScope<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (ALPHA) (Optional) Include activated requests and an existing foreground edit build. | |
| boolean | (ALPHA) (Optional) Include activated edit requests. | |
| string | (ALPHA) (Optional) Restrict activated requests to this object. | |
| TBuild | (ALPHA) Workflow to query. |
Property details
ICopilotScope.isBuilderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Include activated requests and an existing foreground edit build.
readonly isBuilder?: boolean;
ICopilotScope.isEditingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Include activated edit requests.
readonly isEditing?: boolean;
ICopilotScope.objectIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Restrict activated requests to this object.
readonly objectId?: string;
ICopilotScope.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workflow to query.
readonly type: TBuild;