Package com.github.copilot.sdk.generated
package com.github.copilot.sdk.generated
-
ClassDescriptionThe
abortsession event.Data payload forAbortEvent.Theassistant.intentsession event.Data payload forAssistantIntentEvent.Theassistant.message_deltasession event.Data payload forAssistantMessageDeltaEvent.Theassistant.messagesession event.Data payload forAssistantMessageEvent.A tool invocation request from the assistantTool call type: "function" for standard tool calls, "custom" for grammar-based tool calls.Theassistant.reasoning_deltasession event.Data payload forAssistantReasoningDeltaEvent.Theassistant.reasoningsession event.Data payload forAssistantReasoningEvent.Theassistant.streaming_deltasession event.Data payload forAssistantStreamingDeltaEvent.Theassistant.turn_endsession event.Data payload forAssistantTurnEndEvent.Theassistant.turn_startsession event.Data payload forAssistantTurnStartEvent.Theassistant.usagesession event.Data payload forAssistantUsageEvent.Per-request cost and usage data from the CAPI copilot_usage response fieldToken usage detail for a single billing categoryThecapabilities.changedsession event.Data payload forCapabilitiesChangedEvent.UI capability changesThecommand.completedsession event.Data payload forCommandCompletedEvent.Thecommand.executesession event.Data payload forCommandExecuteEvent.Thecommand.queuedsession event.Data payload forCommandQueuedEvent.Thecommands.changedsession event.Data payload forCommandsChangedEvent.Theelicitation.completedsession event.Data payload forElicitationCompletedEvent.The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed)Theelicitation.requestedsession event.Data payload forElicitationRequestedEvent.Elicitation mode; "form" for structured input, "url" for browser-based.ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchemaJSON Schema describing the form fields to present to the user (form mode only)Theexit_plan_mode.completedsession event.Data payload forExitPlanModeCompletedEvent.Theexit_plan_mode.requestedsession event.Data payload forExitPlanModeRequestedEvent.Theexternal_tool.completedsession event.Data payload forExternalToolCompletedEvent.Theexternal_tool.requestedsession event.Data payload forExternalToolRequestedEvent.Thehook.endsession event.Data payload forHookEndEvent.Error details when the hook failedThehook.startsession event.Data payload forHookStartEvent.Themcp.oauth_completedsession event.Data payload forMcpOauthCompletedEvent.Themcp.oauth_requiredsession event.Data payload forMcpOauthRequiredEvent.Static OAuth client configuration, if the server specifies oneThepending_messages.modifiedsession event.Data payload forPendingMessagesModifiedEvent.Thepermission.completedsession event.Data payload forPermissionCompletedEvent.The result of the permission requestThe outcome of the permission requestThepermission.requestedsession event.Data payload forPermissionRequestedEvent.Thesampling.completedsession event.Data payload forSamplingCompletedEvent.Thesampling.requestedsession event.Data payload forSamplingRequestedEvent.Thesession.background_tasks_changedsession event.Data payload forSessionBackgroundTasksChangedEvent.Thesession.compaction_completesession event.Data payload forSessionCompactionCompleteEvent.Token usage breakdown for the compaction LLM callThesession.compaction_startsession event.Data payload forSessionCompactionStartEvent.Thesession.context_changedsession event.Data payload forSessionContextChangedEvent.Hosting platform type of the repository (github or ado)Thesession.custom_agents_updatedsession event.Data payload forSessionCustomAgentsUpdatedEvent.Thesession.errorsession event.Data payload forSessionErrorEvent.Base class for all generated session events.Thesession.extensions_loadedsession event.Data payload forSessionExtensionsLoadedEvent.Discovery sourceCurrent status: running, disabled, failed, or startingThesession.handoffsession event.Data payload forSessionHandoffEvent.Repository context for the handed-off sessionOrigin type of the session being handed offThesession.idlesession event.Data payload forSessionIdleEvent.Thesession.infosession event.Data payload forSessionInfoEvent.Thesession.mcp_servers_loadedsession event.Data payload forSessionMcpServersLoadedEvent.Connection status: connected, failed, needs-auth, pending, disabled, or not_configuredThesession.mcp_server_status_changedsession event.Data payload forSessionMcpServerStatusChangedEvent.New connection status: connected, failed, needs-auth, pending, disabled, or not_configuredThesession.mode_changedsession event.Data payload forSessionModeChangedEvent.Thesession.model_changesession event.Data payload forSessionModelChangeEvent.Thesession.plan_changedsession event.Data payload forSessionPlanChangedEvent.The type of operation performed on the plan fileThesession.remote_steerable_changedsession event.Data payload forSessionRemoteSteerableChangedEvent.Thesession.resumesession event.Data payload forSessionResumeEvent.Updated working directory and git context at resume timeHosting platform type of the repository (github or ado)Thesession.shutdownsession event.Data payload forSessionShutdownEvent.Aggregate code change metrics for the sessionRequest count and cost metricsToken usage breakdownWhether the session ended normally ("routine") or due to a crash/fatal error ("error")Thesession.skills_loadedsession event.Data payload forSessionSkillsLoadedEvent.Thesession.snapshot_rewindsession event.Data payload forSessionSnapshotRewindEvent.Thesession.startsession event.Data payload forSessionStartEvent.Working directory and git context at session startHosting platform type of the repository (github or ado)Thesession.task_completesession event.Data payload forSessionTaskCompleteEvent.Thesession.title_changedsession event.Data payload forSessionTitleChangedEvent.Thesession.tools_updatedsession event.Data payload forSessionToolsUpdatedEvent.Thesession.truncationsession event.Data payload forSessionTruncationEvent.Thesession.usage_infosession event.Data payload forSessionUsageInfoEvent.Thesession.warningsession event.Data payload forSessionWarningEvent.Thesession.workspace_file_changedsession event.Data payload forSessionWorkspaceFileChangedEvent.Whether the file was newly created or updatedTheskill.invokedsession event.Data payload forSkillInvokedEvent.Thesubagent.completedsession event.Data payload forSubagentCompletedEvent.Thesubagent.deselectedsession event.Data payload forSubagentDeselectedEvent.Thesubagent.failedsession event.Data payload forSubagentFailedEvent.Thesubagent.selectedsession event.Data payload forSubagentSelectedEvent.Thesubagent.startedsession event.Data payload forSubagentStartedEvent.Thesystem.messagesession event.Data payload forSystemMessageEvent.Metadata about the prompt template and its constructionMessage role: "system" for system prompts, "developer" for developer-injected instructionsThesystem.notificationsession event.Data payload forSystemNotificationEvent.Thetool.execution_completesession event.Data payload forToolExecutionCompleteEvent.Error details when the tool execution failedTool execution result on successThetool.execution_partial_resultsession event.Data payload forToolExecutionPartialResultEvent.Thetool.execution_progresssession event.Data payload forToolExecutionProgressEvent.Thetool.execution_startsession event.Data payload forToolExecutionStartEvent.Thetool.user_requestedsession event.Data payload forToolUserRequestedEvent.Fallback for event types not yet known to this SDK version.Theuser_input.completedsession event.Data payload forUserInputCompletedEvent.Theuser_input.requestedsession event.Data payload forUserInputRequestedEvent.Theuser.messagesession event.Data payload forUserMessageEvent.The agent mode that was active when this message was sent