ICopilotSnapshot
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Read-only workflow state shared by headless and React consumers.
export interface ICopilotSnapshot<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| readonly ICopilotApplication<TBuild>[] | (ALPHA) In-progress host installations. | |
| ICopilotContext<TBuild> | (ALPHA) Last host facts. | |
| TBuild | (ALPHA) (Optional) Requested creation, before skill activation. | |
| number | (ALPHA) (Optional) Creation revision protecting a newer intent from older application acknowledgements. | |
| ICopilotInteraction<TBuild> | (ALPHA) Foreground chat interaction. | |
| readonly ICopilotRequest<TBuild>[] | (ALPHA) Running responses and workflows waiting for user input across conversations. | |
| number | (ALPHA) Monotonic lifecycle revision, not an allocated identifier. | |
| readonly { readonly target: ICopilotTarget<TBuild>; readonly source?: ICopilotSource; readonly revision: number; }[] | (ALPHA) Last applied origin for each object, including unknown-origin tombstones. |
Property details
ICopilotSnapshot.applicationspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
In-progress host installations.
readonly applications: readonly ICopilotApplication<TBuild>[];
ICopilotSnapshot.contextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Last host facts.
readonly context: ICopilotContext<TBuild>;
ICopilotSnapshot.generationpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Requested creation, before skill activation.
readonly generation?: TBuild;
ICopilotSnapshot.generationRevisionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creation revision protecting a newer intent from older application acknowledgements.
readonly generationRevision?: number;
ICopilotSnapshot.interactionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Foreground chat interaction.
readonly interaction: ICopilotInteraction<TBuild>;
ICopilotSnapshot.requestspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Running responses and workflows waiting for user input across conversations.
readonly requests: readonly ICopilotRequest<TBuild>[];
ICopilotSnapshot.revisionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Monotonic lifecycle revision, not an allocated identifier.
readonly revision: number;
ICopilotSnapshot.sourcespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Last applied origin for each object, including unknown-origin tombstones.
readonly sources: readonly {
readonly target: ICopilotTarget<TBuild>;
readonly source?: ICopilotSource;
readonly revision: number;
}[];