Class AICustomAgentsFrontendApplicationContribution

The command contribution should be implemented to register custom commands and handler.

Implements

Index

Constructors

Properties

customAgentFactory customizationService logger messageService? migrationCheckInFlight migrationPromptShown storageService

Methods

maybeMigrate onStart onStop promptAndMigrate refreshCustomAgents registerCommands showMigrationSummary

Constructors

constructor

new AICustomAgentsFrontendApplicationContribution(): AICustomAgentsFrontendApplicationContribution
Returns AICustomAgentsFrontendApplicationContribution

Properties

`Protected` `Readonly`customAgentFactory

customAgentFactory: CustomAgentFactory

`Protected` `Readonly`customizationService

customizationService: PromptFragmentCustomizationService

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Optional` `Readonly`messageService

messageService?: MessageService

`Protected`migrationCheckInFlight

migrationCheckInFlight: boolean = false

Guards against concurrent pending-migration checks from re-entrant refreshes.

`Protected`migrationPromptShown

migrationPromptShown: boolean = false

Ensures the migration consent prompt is shown at most once per session.

`Protected` `Readonly`storageService

storageService: LocalStorageService

Methods

`Protected`maybeMigrate

maybeMigrate(): Promise<void>
Prompts the user once per session before migrating legacy customAgents.yml files (and before correcting agents migrated with merged headings by an earlier Theia version). Nothing is written until the user confirms. Declining is safe: legacy customAgents.yml files keep being loaded, so agents continue to work unmigrated, and the prompt reappears next session until they migrate or pick "Don't Show Again".

This is intentionally not backed by a preference: the whole migration path is transitional and will be removed once the legacy format is no longer supported. The "don't show again" choice is persisted in local storage (like the dev-container suggestion), so there is no setting to retire.

Returns Promise<void>
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:124

onStart

onStart(): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:81

onStop

onStop(): void
Called when an application is stopped or unloaded.

Note that this is implemented using window.beforeunload which doesn't allow any asynchronous code anymore. I.e. this is the last tick.

Returns void
Implementation of FrontendApplicationContribution.onStop
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:200

`Protected`promptAndMigrate

promptAndMigrate(): Promise<void>
Returns Promise<void>
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:149

`Protected`refreshCustomAgents

refreshCustomAgents(): Promise<void>
Returns Promise<void>
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:86

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:70

`Protected`showMigrationSummary

showMigrationSummary(
    reports: {
        alreadyPresent: number;
        corrected: number;
        failed: number;
        migrated: number;
        promptOverridesMigrated: number;
        scope: URI;
        yamlBackedUp: boolean;
        yamlURI: URI;
    }[],
): void
Parameters
- reports: {
      alreadyPresent: number;
      corrected: number;
      failed: number;
      migrated: number;
      promptOverridesMigrated: number;
      scope: URI;
      yamlBackedUp: boolean;
      yamlURI: URI;
  }[]
Returns void
- Defined in ai-chat/src/browser/custom-agent-frontend-application-contribution.ts:181