Index

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

abort() - Method in class com.github.copilot.sdk.CopilotSession

Aborts the currently processing message in this session.

AbortData(String) - Constructor for record class com.github.copilot.sdk.events.AbortEvent.AbortData

Creates an instance of a AbortData record class.

AbortEvent - Class in com.github.copilot.sdk.events

Event: abort

AbortEvent() - Constructor for class com.github.copilot.sdk.events.AbortEvent

AbortEvent.AbortData - Record Class in com.github.copilot.sdk.events

AbstractSessionEvent - Class in com.github.copilot.sdk.events

Base class for all session events in the Copilot SDK.

AbstractSessionEvent() - Constructor for class com.github.copilot.sdk.events.AbstractSessionEvent

additionalContext() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Returns the value of the additionalContext record component.

additionalContext() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns the value of the additionalContext record component.

additionalContext() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput

Returns the value of the additionalContext record component.

additionalContext() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Returns the value of the additionalContext record component.

agentDescription() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns the value of the agentDescription record component.

agentDisplayName() - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Returns the value of the agentDisplayName record component.

agentDisplayName() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns the value of the agentDisplayName record component.

agentName() - Method in record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Returns the value of the agentName record component.

agentName() - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Returns the value of the agentName record component.

agentName() - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Returns the value of the agentName record component.

agentName() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns the value of the agentName record component.

allow() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an output that allows the tool to execute.

allowedTools() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns the value of the allowedTools record component.

apiCallId() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the apiCallId record component.

APPEND - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode

Append the custom content to the default system message.

arguments() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Returns the value of the arguments record component.

arguments() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the arguments record component.

arguments() - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Returns the value of the arguments record component.

ask() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an output that asks for user confirmation before executing the tool.

AssistantIntentData(String) - Constructor for record class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData

Creates an instance of a AssistantIntentData record class.

AssistantIntentEvent - Class in com.github.copilot.sdk.events

Event: assistant.intent

AssistantIntentEvent() - Constructor for class com.github.copilot.sdk.events.AssistantIntentEvent

AssistantIntentEvent.AssistantIntentData - Record Class in com.github.copilot.sdk.events

AssistantMessageData(String, String, List<AssistantMessageEvent.AssistantMessageData.ToolRequest>, String, String, String, String) - Constructor for record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Creates an instance of a AssistantMessageData record class.

AssistantMessageDeltaData(String, String, Double, String) - Constructor for record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Creates an instance of a AssistantMessageDeltaData record class.

AssistantMessageDeltaEvent - Class in com.github.copilot.sdk.events

Event: assistant.message_delta

AssistantMessageDeltaEvent() - Constructor for class com.github.copilot.sdk.events.AssistantMessageDeltaEvent

AssistantMessageDeltaEvent.AssistantMessageDeltaData - Record Class in com.github.copilot.sdk.events

AssistantMessageEvent - Class in com.github.copilot.sdk.events

Event representing a complete message from the assistant.

AssistantMessageEvent() - Constructor for class com.github.copilot.sdk.events.AssistantMessageEvent

AssistantMessageEvent.AssistantMessageData - Record Class in com.github.copilot.sdk.events

Contains the assistant message content and metadata.

AssistantMessageEvent.AssistantMessageData.ToolRequest - Record Class in com.github.copilot.sdk.events

Represents a request from the assistant to invoke a tool.

AssistantReasoningData(String, String) - Constructor for record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Creates an instance of a AssistantReasoningData record class.

AssistantReasoningDeltaData(String, String) - Constructor for record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Creates an instance of a AssistantReasoningDeltaData record class.

AssistantReasoningDeltaEvent - Class in com.github.copilot.sdk.events

Event: assistant.reasoning_delta

AssistantReasoningDeltaEvent() - Constructor for class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent

AssistantReasoningDeltaEvent.AssistantReasoningDeltaData - Record Class in com.github.copilot.sdk.events

AssistantReasoningEvent - Class in com.github.copilot.sdk.events

Event: assistant.reasoning

AssistantReasoningEvent() - Constructor for class com.github.copilot.sdk.events.AssistantReasoningEvent

AssistantReasoningEvent.AssistantReasoningData - Record Class in com.github.copilot.sdk.events

AssistantTurnEndData(String) - Constructor for record class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData

Creates an instance of a AssistantTurnEndData record class.

AssistantTurnEndEvent - Class in com.github.copilot.sdk.events

Event: assistant.turn_end

AssistantTurnEndEvent() - Constructor for class com.github.copilot.sdk.events.AssistantTurnEndEvent

AssistantTurnEndEvent.AssistantTurnEndData - Record Class in com.github.copilot.sdk.events

AssistantTurnStartData(String) - Constructor for record class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData

Creates an instance of a AssistantTurnStartData record class.

AssistantTurnStartEvent - Class in com.github.copilot.sdk.events

Event: assistant.turn_start

AssistantTurnStartEvent() - Constructor for class com.github.copilot.sdk.events.AssistantTurnStartEvent

AssistantTurnStartEvent.AssistantTurnStartData - Record Class in com.github.copilot.sdk.events

AssistantUsageData(String, Double, Double, Double, Double, Double, Double, String, String, String, String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Creates an instance of a AssistantUsageData record class.

AssistantUsageEvent - Class in com.github.copilot.sdk.events

Event: assistant.usage

AssistantUsageEvent() - Constructor for class com.github.copilot.sdk.events.AssistantUsageEvent

AssistantUsageEvent.AssistantUsageData - Record Class in com.github.copilot.sdk.events

Attachment - Record Class in com.github.copilot.sdk.json

Represents a file attachment to include with a message.

Attachment(String, String, String) - Constructor for record class com.github.copilot.sdk.json.Attachment

Creates an instance of a Attachment record class.

Attachment(String, String, String, String, String, UserMessageEvent.UserMessageData.Attachment.Selection) - Constructor for record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Creates an instance of a Attachment record class.

attachments() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns a defensive copy of the attachments list.

AUTOCLOSEABLE_TIMEOUT_SECONDS - Static variable in class com.github.copilot.sdk.CopilotClient

Timeout, in seconds, used by CopilotClient.close() when waiting for graceful shutdown via CopilotClient.stop().

AzureOptions - Class in com.github.copilot.sdk.json

Azure OpenAI-specific configuration options.

AzureOptions() - Constructor for class com.github.copilot.sdk.json.AzureOptions

B

BACKGROUND - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes

Event fired when a session moves to background (TUI+server mode).

binaryResultsForLlm() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the binaryResultsForLlm record component.

branch() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Returns the value of the branch record component.

C

cachedInput() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Returns the value of the cachedInput record component.

cacheReadTokens() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the cacheReadTokens record component.

cacheWriteTokens() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the cacheWriteTokens record component.

character() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Returns the value of the character record component.

checkpointNumber() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the checkpointNumber record component.

checkpointPath() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the checkpointPath record component.

cleanupActions() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Returns the value of the cleanupActions record component.

close() - Method in class com.github.copilot.sdk.CopilotClient

Closes this client using graceful shutdown semantics.

close() - Method in class com.github.copilot.sdk.CopilotSession

Disposes the session and releases all associated resources.

code() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Returns the value of the code record component.

codeChanges() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the codeChanges record component.

CodeChanges(double, double, List<String>) - Constructor for record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Creates an instance of a CodeChanges record class.

com.github.copilot.sdk - package com.github.copilot.sdk

Core classes for the GitHub Copilot SDK for Java.

com.github.copilot.sdk.events - package com.github.copilot.sdk.events

Event types emitted during Copilot session processing.

com.github.copilot.sdk.json - package com.github.copilot.sdk.json

Configuration classes and data transfer objects for the Copilot SDK.

compactionTokensUsed() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the compactionTokensUsed record component.

CompactionTokensUsed(double, double, double) - Constructor for record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Creates an instance of a CompactionTokensUsed record class.

CONNECTED - Enum constant in enum class com.github.copilot.sdk.ConnectionState

The client is connected and ready to accept requests.

CONNECTING - Enum constant in enum class com.github.copilot.sdk.ConnectionState

The client is in the process of connecting to the server.

ConnectionState - Enum Class in com.github.copilot.sdk

Represents the connection state of a CopilotClient.

content() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the content record component.

content() - Method in record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Returns the value of the content record component.

content() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns the value of the content record component.

content() - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Returns the value of the content record component.

content() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Returns the value of the content record component.

content() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns the value of the content record component.

context() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the context record component.

CopilotClient - Class in com.github.copilot.sdk

Provides a client for interacting with the Copilot CLI server.

CopilotClient() - Constructor for class com.github.copilot.sdk.CopilotClient

Creates a new CopilotClient with default options.

CopilotClient(CopilotClientOptions) - Constructor for class com.github.copilot.sdk.CopilotClient

Creates a new CopilotClient with the specified options.

CopilotClientOptions - Class in com.github.copilot.sdk.json

Configuration options for creating a CopilotClient.

CopilotClientOptions() - Constructor for class com.github.copilot.sdk.json.CopilotClientOptions

CopilotSession - Class in com.github.copilot.sdk

Represents a single conversation session with the Copilot CLI.

copilotVersion() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the copilotVersion record component.

cost() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the cost record component.

create(String, String, Map<String, Object>, ToolHandler) - Static method in record class com.github.copilot.sdk.json.ToolDefinition

Creates a tool definition with a JSON schema for parameters.

CREATED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes

Event fired when a session is created.

createSession() - Method in class com.github.copilot.sdk.CopilotClient

Creates a new Copilot session with default configuration.

createSession(SessionConfig) - Method in class com.github.copilot.sdk.CopilotClient

Creates a new Copilot session with the specified configuration.

CreateSessionRequest - Class in com.github.copilot.sdk.json

Internal request object for creating a new session.

CreateSessionRequest() - Constructor for class com.github.copilot.sdk.json.CreateSessionRequest

CreateSessionResponse - Record Class in com.github.copilot.sdk.json

Internal response object from creating a session.

CreateSessionResponse(String, String) - Constructor for record class com.github.copilot.sdk.json.CreateSessionResponse

Creates an instance of a CreateSessionResponse record class.

currentModel() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the currentModel record component.

currentTokens() - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Returns the value of the currentTokens record component.

CustomAgentConfig - Class in com.github.copilot.sdk.json

Configuration for a custom agent in a Copilot session.

CustomAgentConfig() - Constructor for class com.github.copilot.sdk.json.CustomAgentConfig

cwd() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns the value of the cwd record component.

cwd() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns the value of the cwd record component.

cwd() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Returns the value of the cwd record component.

D

data() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns the value of the data record component.

DELETED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes

Event fired when a session is deleted.

deleteSession(String) - Method in class com.github.copilot.sdk.CopilotClient

Deletes a session by ID.

DeleteSessionResponse - Record Class in com.github.copilot.sdk.json

Internal response object from deleting a session.

DeleteSessionResponse(boolean, String) - Constructor for record class com.github.copilot.sdk.json.DeleteSessionResponse

Creates an instance of a DeleteSessionResponse record class.

deltaContent() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns the value of the deltaContent record component.

deltaContent() - Method in record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Returns the value of the deltaContent record component.

deny() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an output that denies the tool execution.

deny(String) - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an output that denies the tool execution with a reason.

description() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns the value of the description record component.

description() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns the value of the description record component.

detailedContent() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Returns the value of the detailedContent record component.

DISCONNECTED - Enum constant in enum class com.github.copilot.sdk.ConnectionState

The client is not connected to the server.

displayName() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the displayName record component.

displayName() - Method in record class com.github.copilot.sdk.json.Attachment

Returns the value of the displayName record component.

duration() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the duration record component.

E

encryptedContent() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the encryptedContent record component.

end() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Returns the value of the end record component.

equals(Object) - Method in record class com.github.copilot.sdk.events.AbortEvent.AbortData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.PendingMessagesModifiedEvent.PendingMessagesModifiedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionCompactionStartEvent.SessionCompactionStartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionIdleEvent.SessionIdleData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.Attachment

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.CreateSessionResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.GetMessagesResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.ListSessionsResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.PingResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SendMessageResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.ToolDefinition

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.ToolResultObject

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Indicates whether some other object is "equal to" this one.

error() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Returns the value of the error record component.

error() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the error record component.

error(String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject

Creates an error result with the given error message.

error(String, String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject

Creates an error result with both a text result and error message.

Error(String, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Creates an instance of a Error record class.

ERROR - Enum constant in enum class com.github.copilot.sdk.ConnectionState

The client encountered an error during connection or operation.

ERROR - Enum constant in enum class com.github.copilot.sdk.events.SessionShutdownEvent.ShutdownType

errorReason() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the errorReason record component.

errorType() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns the value of the errorType record component.

eventCount() - Method in record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Returns the value of the eventCount record component.

EventErrorHandler - Interface in com.github.copilot.sdk

A handler for errors thrown by event handlers during event dispatch.

EventErrorPolicy - Enum Class in com.github.copilot.sdk

Controls how event dispatch behaves when an event handler throws an exception.

events() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse

Returns the value of the events record component.

eventsRemoved() - Method in record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Returns the value of the eventsRemoved record component.

F

failure(String, String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject

Creates a failure result with the given text and error message.

filePath() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the filePath record component.

filesModified() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Returns the value of the filesModified record component.

finalMessage() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns the value of the finalMessage record component.

forceStop() - Method in class com.github.copilot.sdk.CopilotClient

Forces an immediate stop of the client without graceful cleanup.

FOREGROUND - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes

Event fired when a session moves to foreground (TUI+server mode).

G

get() - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion

Gets the SDK protocol version.

getAllowFreeform() - Method in class com.github.copilot.sdk.json.UserInputRequest

Returns whether freeform text input is allowed.

getAnswer() - Method in class com.github.copilot.sdk.json.UserInputResponse

Gets the user's answer.

getApiKey() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the API key.

getApiVersion() - Method in class com.github.copilot.sdk.json.AzureOptions

Gets the Azure OpenAI API version.

getArguments() - Method in class com.github.copilot.sdk.json.ToolInvocation

Gets the arguments passed to the tool as a Map.

getArgumentsAs(Class<T>) - Method in class com.github.copilot.sdk.json.ToolInvocation

Deserializes the tool arguments into the specified type.

getAttachments() - Method in class com.github.copilot.sdk.json.MessageOptions

Gets the file attachments.

getAttachments() - Method in class com.github.copilot.sdk.json.SendMessageRequest

Gets the attachments.

getAuthStatus() - Method in class com.github.copilot.sdk.CopilotClient

Gets current authentication status.

GetAuthStatusResponse - Class in com.github.copilot.sdk.json

Response from the auth.getStatus RPC call.

GetAuthStatusResponse() - Constructor for class com.github.copilot.sdk.json.GetAuthStatusResponse

getAuthType() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

getAvailableTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets available tools.

getAvailableTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the list of allowed tool names.

getAvailableTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets available tools.

getAvailableTools() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the list of allowed tool names.

getAzure() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the Azure-specific options.

getBackgroundCompactionThreshold() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Gets the background compaction threshold.

getBaseUrl() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the base URL for the API.

getBearerToken() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the bearer token.

getBilling() - Method in class com.github.copilot.sdk.json.ModelInfo

getBranch() - Method in class com.github.copilot.sdk.json.SessionContext

Gets the current git branch.

getBufferExhaustionThreshold() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Gets the buffer exhaustion threshold.

getCapabilities() - Method in class com.github.copilot.sdk.json.ModelInfo

getChoices() - Method in class com.github.copilot.sdk.json.UserInputRequest

Gets the optional choices for multiple choice questions.

getCliArgs() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the extra CLI arguments.

getCliPath() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the path to the Copilot CLI executable.

getCliUrl() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the URL of an existing CLI server to connect to.

getCode() - Method in class com.github.copilot.sdk.json.JsonRpcError

Gets the error code.

getConfigDir() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets config directory.

getConfigDir() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the configuration directory path.

getConfigDir() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets config directory.

getConfigDir() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the custom configuration directory.

getContent() - Method in class com.github.copilot.sdk.json.SystemMessageConfig

Gets the system message content.

getContext() - Method in class com.github.copilot.sdk.json.SessionMetadata

Gets the working directory context from session creation.

getCustomAgents() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets custom agents.

getCustomAgents() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the custom agent configurations.

getCustomAgents() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets custom agents.

getCustomAgents() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the custom agent configurations.

getCwd() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the working directory for the CLI process.

getCwd() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Gets the current working directory.

getCwd() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Gets the current working directory.

getCwd() - Method in class com.github.copilot.sdk.json.SessionContext

Gets the working directory where the session was created.

getData() - Method in class com.github.copilot.sdk.events.AbortEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantIntentEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent

Gets the message data.

getData() - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantTurnEndEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantTurnStartEvent

getData() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent

getData() - Method in class com.github.copilot.sdk.events.HookEndEvent

getData() - Method in class com.github.copilot.sdk.events.HookStartEvent

getData() - Method in class com.github.copilot.sdk.events.PendingMessagesModifiedEvent

getData() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent

getData() - Method in class com.github.copilot.sdk.events.SessionCompactionStartEvent

getData() - Method in class com.github.copilot.sdk.events.SessionContextChangedEvent

getData() - Method in class com.github.copilot.sdk.events.SessionErrorEvent

getData() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent

getData() - Method in class com.github.copilot.sdk.events.SessionIdleEvent

getData() - Method in class com.github.copilot.sdk.events.SessionInfoEvent

getData() - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent

getData() - Method in class com.github.copilot.sdk.events.SessionResumeEvent

getData() - Method in class com.github.copilot.sdk.events.SessionShutdownEvent

getData() - Method in class com.github.copilot.sdk.events.SessionSnapshotRewindEvent

getData() - Method in class com.github.copilot.sdk.events.SessionStartEvent

getData() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent

getData() - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent

getData() - Method in class com.github.copilot.sdk.events.SkillInvokedEvent

getData() - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent

getData() - Method in class com.github.copilot.sdk.events.SubagentFailedEvent

getData() - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent

getData() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent

getData() - Method in class com.github.copilot.sdk.events.SystemMessageEvent

getData() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent

getData() - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent

getData() - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent

getData() - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent

getData() - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent

getData() - Method in class com.github.copilot.sdk.events.UserMessageEvent

getData() - Method in class com.github.copilot.sdk.json.JsonRpcError

Gets the additional error data.

getDefaultReasoningEffort() - Method in class com.github.copilot.sdk.json.ModelInfo

Gets the default reasoning effort level.

getDescription() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the agent description.

getDisabledSkills() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets disabled skills.

getDisabledSkills() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the disabled skills.

getDisabledSkills() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets disabled skills.

getDisabledSkills() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the disabled skill names.

getDisableResume() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets disable resume flag.

getDisplayName() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the human-readable display name.

getEnabled() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Gets whether infinite sessions are enabled.

getEnvironment() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the environment variables for the CLI process.

getEphemeral() - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Returns whether this is an ephemeral event.

getError() - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Gets the error if the RPC call failed.

getExcludedTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets excluded tools.

getExcludedTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the list of excluded tool names.

getExcludedTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets excluded tools.

getExcludedTools() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the list of excluded tool names.

getExtensionData() - Method in class com.github.copilot.sdk.json.PermissionRequest

Gets additional extension data for the request.

getForegroundSessionId() - Method in class com.github.copilot.sdk.CopilotClient

Gets the ID of the session currently displayed in the TUI.

GetForegroundSessionResponse - Record Class in com.github.copilot.sdk.json

Response from session.getForeground RPC call.

GetForegroundSessionResponse(String, String) - Constructor for record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Creates an instance of a GetForegroundSessionResponse record class.

getGithubToken() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the GitHub token for authentication.

getGitRoot() - Method in class com.github.copilot.sdk.json.SessionContext

Gets the git repository root directory.

getHooks() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets hooks flag.

getHooks() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the hook handlers configuration.

getHooks() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets hooks flag.

getHooks() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the hook handlers configuration.

getHost() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

getId() - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Gets the unique identifier for this event.

getId() - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Gets the request ID.

getId() - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Gets the response ID.

getId() - Method in class com.github.copilot.sdk.json.ModelInfo

getInfer() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets whether inference mode is enabled.

getInfiniteSessions() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets infinite sessions config.

getInfiniteSessions() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the infinite session configuration.

getInfiniteSessions() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets infinite sessions config.

getInfiniteSessions() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the infinite sessions configuration.

getJsonrpc() - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Gets the JSON-RPC version.

getJsonrpc() - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Gets the JSON-RPC version.

getKind() - Method in class com.github.copilot.sdk.json.PermissionRequest

Gets the kind of permission being requested.

getKind() - Method in class com.github.copilot.sdk.json.PermissionRequestResult

Gets the result kind.

getLastSessionId() - Method in class com.github.copilot.sdk.CopilotClient

Gets the ID of the most recently used session.

GetLastSessionIdResponse - Record Class in com.github.copilot.sdk.json

Internal response object from getting the last session ID.

GetLastSessionIdResponse(String) - Constructor for record class com.github.copilot.sdk.json.GetLastSessionIdResponse

Creates an instance of a GetLastSessionIdResponse record class.

getLimits() - Method in class com.github.copilot.sdk.json.ModelCapabilities

getLogin() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

getLogLevel() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the log level for the CLI process.

getMaxContextWindowTokens() - Method in class com.github.copilot.sdk.json.ModelLimits

getMaxPromptImages() - Method in class com.github.copilot.sdk.json.ModelVisionLimits

getMaxPromptImageSize() - Method in class com.github.copilot.sdk.json.ModelVisionLimits

getMaxPromptTokens() - Method in class com.github.copilot.sdk.json.ModelLimits

getMcpServers() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets MCP servers.

getMcpServers() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the MCP server configurations for this agent.

getMcpServers() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the MCP server configurations.

getMcpServers() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets MCP servers.

getMcpServers() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the MCP server configurations.

getMessage() - Method in class com.github.copilot.sdk.json.JsonRpcError

Gets the error message.

getMessages() - Method in class com.github.copilot.sdk.CopilotSession

Gets the complete list of messages and events in the session.

GetMessagesResponse - Record Class in com.github.copilot.sdk.json

Internal response object from getting session messages.

GetMessagesResponse(List<JsonNode>) - Constructor for record class com.github.copilot.sdk.json.GetMessagesResponse

Creates an instance of a GetMessagesResponse record class.

getMetadata() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

getMethod() - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Gets the method name.

getMode() - Method in class com.github.copilot.sdk.json.MessageOptions

Gets the delivery mode.

getMode() - Method in class com.github.copilot.sdk.json.SendMessageRequest

Gets the mode.

getMode() - Method in class com.github.copilot.sdk.json.SystemMessageConfig

Gets the system message mode.

getModel() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the model name.

getModel() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the AI model to use.

getModel() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the model name.

getModel() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the AI model to use.

getModels() - Method in class com.github.copilot.sdk.json.GetModelsResponse

GetModelsResponse - Class in com.github.copilot.sdk.json

Response from the models.list RPC call.

GetModelsResponse() - Constructor for class com.github.copilot.sdk.json.GetModelsResponse

getModifiedTime() - Method in class com.github.copilot.sdk.json.SessionMetadata

Gets the timestamp when the session was last modified.

getMultiplier() - Method in class com.github.copilot.sdk.json.ModelBilling

getName() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the unique identifier name for this agent.

getName() - Method in class com.github.copilot.sdk.json.ModelInfo

getOnPermissionRequest() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the permission request handler.

getOnPermissionRequest() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the permission request handler.

getOnPostToolUse() - Method in class com.github.copilot.sdk.json.SessionHooks

Gets the post-tool-use handler.

getOnPreToolUse() - Method in class com.github.copilot.sdk.json.SessionHooks

Gets the pre-tool-use handler.

getOnSessionEnd() - Method in class com.github.copilot.sdk.json.SessionHooks

Gets the session-end handler.

getOnSessionStart() - Method in class com.github.copilot.sdk.json.SessionHooks

Gets the session-start handler.

getOnUserInputRequest() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the user input request handler.

getOnUserInputRequest() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the user input request handler.

getOnUserPromptSubmitted() - Method in class com.github.copilot.sdk.json.SessionHooks

Gets the user-prompt-submitted handler.

getParams() - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Gets the method parameters.

getParentId() - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Gets the parent event ID, if this event is a child of another.

getPolicy() - Method in class com.github.copilot.sdk.json.ModelInfo

getPort() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Gets the TCP port for the CLI server.

getPrompt() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the system prompt for this agent.

getPrompt() - Method in class com.github.copilot.sdk.json.MessageOptions

Gets the message prompt.

getPrompt() - Method in class com.github.copilot.sdk.json.SendMessageRequest

Gets the message prompt.

getProtocolVersion() - Method in class com.github.copilot.sdk.json.GetStatusResponse

getProvider() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the provider config.

getProvider() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the custom API provider configuration.

getProvider() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the provider config.

getProvider() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the custom API provider configuration.

getQuestion() - Method in class com.github.copilot.sdk.json.UserInputRequest

Gets the question to ask the user.

getReasoningEffort() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the reasoning effort.

getReasoningEffort() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the reasoning effort level.

getReasoningEffort() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the reasoning effort.

getReasoningEffort() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the reasoning effort level.

getRepository() - Method in class com.github.copilot.sdk.json.SessionContext

Gets the GitHub repository in "owner/repo" format.

getRequestPermission() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets request permission flag.

getRequestPermission() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets request permission flag.

getRequestUserInput() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets request user input flag.

getRequestUserInput() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets request user input flag.

getResult() - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Gets the result of the RPC call.

getRules() - Method in class com.github.copilot.sdk.json.PermissionRequestResult

Gets the approval rules.

getSessionId() - Method in class com.github.copilot.sdk.CopilotSession

Gets the unique identifier for this session.

getSessionId() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the session ID.

getSessionId() - Method in class com.github.copilot.sdk.json.HookInvocation

Gets the session ID.

getSessionId() - Method in class com.github.copilot.sdk.json.PermissionInvocation

Gets the session ID where the permission was requested.

getSessionId() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the session ID.

getSessionId() - Method in class com.github.copilot.sdk.json.SendMessageRequest

Gets the session ID.

getSessionId() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the custom session ID.

getSessionId() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

getSessionId() - Method in class com.github.copilot.sdk.json.SessionMetadata

Gets the unique identifier for this session.

getSessionId() - Method in class com.github.copilot.sdk.json.ToolInvocation

Gets the session ID where the tool was invoked.

getSessionId() - Method in class com.github.copilot.sdk.json.UserInputInvocation

Gets the session ID.

getSkillDirectories() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets skill directories.

getSkillDirectories() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the skill directories.

getSkillDirectories() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets skill directories.

getSkillDirectories() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the skill directories.

getStartTime() - Method in class com.github.copilot.sdk.json.SessionMetadata

Gets the timestamp when the session was created.

getState() - Method in class com.github.copilot.sdk.CopilotClient

Gets the current connection state.

getState() - Method in class com.github.copilot.sdk.json.ModelPolicy

getStatus() - Method in class com.github.copilot.sdk.CopilotClient

Gets CLI status including version and protocol information.

getStatusMessage() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

GetStatusResponse - Class in com.github.copilot.sdk.json

Response from the status.get RPC call.

GetStatusResponse() - Constructor for class com.github.copilot.sdk.json.GetStatusResponse

getStreaming() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets streaming flag.

getStreaming() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets streaming flag.

getSummary() - Method in class com.github.copilot.sdk.json.SessionMetadata

Gets a brief summary of the session's conversation.

getSupportedMediaTypes() - Method in class com.github.copilot.sdk.json.ModelVisionLimits

getSupportedReasoningEfforts() - Method in class com.github.copilot.sdk.json.ModelInfo

Gets the supported reasoning effort levels.

getSupports() - Method in class com.github.copilot.sdk.json.ModelCapabilities

getSystemMessage() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the system message config.

getSystemMessage() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the system message configuration.

getSystemMessage() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the system message config.

getSystemMessage() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the system message configuration.

getTerms() - Method in class com.github.copilot.sdk.json.ModelPolicy

getTimestamp() - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Gets the timestamp when this event occurred.

getTimestamp() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Gets the timestamp of the hook invocation.

getTimestamp() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Gets the timestamp of the hook invocation.

getToolArgs() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Gets the arguments passed to the tool.

getToolArgs() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Gets the arguments passed to the tool.

getToolCallId() - Method in class com.github.copilot.sdk.json.PermissionRequest

Gets the associated tool call ID, if applicable.

getToolCallId() - Method in class com.github.copilot.sdk.json.ToolInvocation

Gets the unique identifier for this tool call.

getToolName() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Gets the name of the tool that was invoked.

getToolName() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Gets the name of the tool being invoked.

getToolName() - Method in class com.github.copilot.sdk.json.ToolInvocation

Gets the name of the tool being invoked.

getToolResult() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Gets the result returned by the tool.

getTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets the tools.

getTools() - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Gets the list of tool names available to this agent.

getTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the custom tools for this session.

getTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets the tools.

getTools() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the custom tools for this session.

getType() - Method in class com.github.copilot.sdk.events.AbortEvent

getType() - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Gets the event type discriminator string.

getType() - Method in class com.github.copilot.sdk.events.AssistantIntentEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent

Gets the event type discriminator string.

getType() - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantTurnEndEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantTurnStartEvent

getType() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent

getType() - Method in class com.github.copilot.sdk.events.HookEndEvent

getType() - Method in class com.github.copilot.sdk.events.HookStartEvent

getType() - Method in class com.github.copilot.sdk.events.PendingMessagesModifiedEvent

getType() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent

getType() - Method in class com.github.copilot.sdk.events.SessionCompactionStartEvent

getType() - Method in class com.github.copilot.sdk.events.SessionContextChangedEvent

getType() - Method in class com.github.copilot.sdk.events.SessionErrorEvent

getType() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent

getType() - Method in class com.github.copilot.sdk.events.SessionIdleEvent

getType() - Method in class com.github.copilot.sdk.events.SessionInfoEvent

getType() - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent

getType() - Method in class com.github.copilot.sdk.events.SessionResumeEvent

getType() - Method in class com.github.copilot.sdk.events.SessionShutdownEvent

getType() - Method in class com.github.copilot.sdk.events.SessionSnapshotRewindEvent

getType() - Method in class com.github.copilot.sdk.events.SessionStartEvent

getType() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent

getType() - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent

getType() - Method in class com.github.copilot.sdk.events.SkillInvokedEvent

getType() - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent

getType() - Method in class com.github.copilot.sdk.events.SubagentFailedEvent

getType() - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent

getType() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent

getType() - Method in class com.github.copilot.sdk.events.SystemMessageEvent

getType() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent

getType() - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent

getType() - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent

getType() - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent

getType() - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent

getType() - Method in class com.github.copilot.sdk.events.UserMessageEvent

getType() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the provider type.

getType() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

getUseLoggedInUser() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Returns whether to use the logged-in user for authentication.

getValue() - Method in enum class com.github.copilot.sdk.SystemMessageMode

Returns the JSON value for this mode.

getVersion() - Method in class com.github.copilot.sdk.json.GetStatusResponse

getVersionNumber() - Method in enum class com.github.copilot.sdk.SdkProtocolVersion

getVision() - Method in class com.github.copilot.sdk.json.ModelLimits

getWireApi() - Method in class com.github.copilot.sdk.json.ProviderConfig

Gets the wire API format.

getWorkingDirectory() - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Gets working directory.

getWorkingDirectory() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Gets the working directory for the session.

getWorkingDirectory() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Gets working directory.

getWorkingDirectory() - Method in class com.github.copilot.sdk.json.SessionConfig

Gets the working directory for the session.

getWorkspacePath() - Method in class com.github.copilot.sdk.CopilotSession

Gets the path to the session workspace directory when infinite sessions are enabled.

H

handle(PermissionRequest, PermissionInvocation) - Method in interface com.github.copilot.sdk.json.PermissionHandler

Handles a permission request from the assistant.

handle(PostToolUseHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.PostToolUseHandler

Handles a post-tool-use hook invocation.

handle(PreToolUseHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.PreToolUseHandler

Handles a pre-tool-use hook invocation.

handle(SessionEndHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.SessionEndHandler

Handles a session end event.

handle(SessionStartHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.SessionStartHandler

Handles a session start event.

handle(UserInputRequest, UserInputInvocation) - Method in interface com.github.copilot.sdk.json.UserInputHandler

Handles a user input request from the agent.

handle(UserPromptSubmittedHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.UserPromptSubmittedHandler

Handles a user prompt submission event.

handleError(AbstractSessionEvent, Exception) - Method in interface com.github.copilot.sdk.EventErrorHandler

Called when an event handler throws an exception during event dispatch.

handler() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns the value of the handler record component.

handoffTime() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the handoffTime record component.

hashCode() - Method in record class com.github.copilot.sdk.events.AbortEvent.AbortData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.PendingMessagesModifiedEvent.PendingMessagesModifiedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionCompactionStartEvent.SessionCompactionStartData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionIdleEvent.SessionIdleData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.Attachment

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.PingResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SendMessageResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Returns a hash code value for this object.

hashCode() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Returns a hash code value for this object.

hasHooks() - Method in class com.github.copilot.sdk.json.SessionHooks

Returns whether any hooks are registered.

HookEndData(String, String, Object, boolean, HookEndEvent.HookEndData.HookError) - Constructor for record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Creates an instance of a HookEndData record class.

HookEndEvent - Class in com.github.copilot.sdk.events

Event: hook.end

HookEndEvent() - Constructor for class com.github.copilot.sdk.events.HookEndEvent

HookEndEvent.HookEndData - Record Class in com.github.copilot.sdk.events

HookEndEvent.HookEndData.HookError - Record Class in com.github.copilot.sdk.events

HookError(String, String) - Constructor for record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Creates an instance of a HookError record class.

HookInvocation - Class in com.github.copilot.sdk.json

Context for a hook invocation.

HookInvocation() - Constructor for class com.github.copilot.sdk.json.HookInvocation

hookInvocationId() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns the value of the hookInvocationId record component.

hookInvocationId() - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Returns the value of the hookInvocationId record component.

HookStartData(String, String, Object) - Constructor for record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Creates an instance of a HookStartData record class.

HookStartEvent - Class in com.github.copilot.sdk.events

Event: hook.start

HookStartEvent() - Constructor for class com.github.copilot.sdk.events.HookStartEvent

HookStartEvent.HookStartData - Record Class in com.github.copilot.sdk.events

hookType() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns the value of the hookType record component.

hookType() - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Returns the value of the hookType record component.

I

InfiniteSessionConfig - Class in com.github.copilot.sdk.json

Configuration for infinite sessions with automatic context compaction and workspace persistence.

InfiniteSessionConfig() - Constructor for class com.github.copilot.sdk.json.InfiniteSessionConfig

infoType() - Method in record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Returns the value of the infoType record component.

initialPrompt() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns the value of the initialPrompt record component.

initiator() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the initiator record component.

input() - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Returns the value of the input record component.

input() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Returns the value of the input record component.

inputTokens() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the inputTokens record component.

intent() - Method in record class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData

Returns the value of the intent record component.

invoke(ToolInvocation) - Method in interface com.github.copilot.sdk.json.ToolHandler

Invokes the tool with the given invocation context.

isAuthenticated() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

isAutoRestart() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Returns whether the client should automatically restart the server on crash.

isAutoStart() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Returns whether the client should automatically start the server.

isDisableResume() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Returns whether the resume event is disabled.

isReasoningEffort() - Method in class com.github.copilot.sdk.json.ModelSupports

Returns whether this model supports reasoning effort configuration.

isRemote() - Method in class com.github.copilot.sdk.json.SessionMetadata

Returns whether this session is stored remotely.

isStreaming() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Returns whether streaming is enabled.

isStreaming() - Method in class com.github.copilot.sdk.json.SessionConfig

Returns whether streaming is enabled.

isUserRequested() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the isUserRequested record component.

isUseStdio() - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Returns whether to use stdio transport instead of TCP.

isVision() - Method in class com.github.copilot.sdk.json.ModelSupports

isWasFreeform() - Method in class com.github.copilot.sdk.json.UserInputResponse

Returns whether the answer was freeform (not from the provided choices).

J

JsonRpcError - Class in com.github.copilot.sdk.json

JSON-RPC 2.0 error structure.

JsonRpcError() - Constructor for class com.github.copilot.sdk.json.JsonRpcError

JsonRpcRequest - Class in com.github.copilot.sdk.json

JSON-RPC 2.0 request structure.

JsonRpcRequest() - Constructor for class com.github.copilot.sdk.json.JsonRpcRequest

JsonRpcResponse - Class in com.github.copilot.sdk.json

JSON-RPC 2.0 response structure.

JsonRpcResponse() - Constructor for class com.github.copilot.sdk.json.JsonRpcResponse

L

LATEST - Enum constant in enum class com.github.copilot.sdk.SdkProtocolVersion

line() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Returns the value of the line record component.

linesAdded() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Returns the value of the linesAdded record component.

linesRemoved() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Returns the value of the linesRemoved record component.

listModels() - Method in class com.github.copilot.sdk.CopilotClient

Lists available models with their metadata.

listSessions() - Method in class com.github.copilot.sdk.CopilotClient

Lists all available sessions.

listSessions(SessionListFilter) - Method in class com.github.copilot.sdk.CopilotClient

Lists all available sessions with optional filtering.

ListSessionsResponse - Record Class in com.github.copilot.sdk.json

Internal response object from listing sessions.

ListSessionsResponse(List<SessionMetadata>) - Constructor for record class com.github.copilot.sdk.json.ListSessionsResponse

Creates an instance of a ListSessionsResponse record class.

M

mcpServerName() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the mcpServerName record component.

mcpToolName() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the mcpToolName record component.

message() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Returns the value of the message record component.

message() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns the value of the message record component.

message() - Method in record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Returns the value of the message record component.

message() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Returns the value of the message record component.

message() - Method in record class com.github.copilot.sdk.json.PingResponse

Returns the value of the message record component.

messageId() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns the value of the messageId record component.

messageId() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the messageId record component.

messageId() - Method in record class com.github.copilot.sdk.json.SendMessageResponse

Returns the value of the messageId record component.

MessageOptions - Class in com.github.copilot.sdk.json

Options for sending a message to a Copilot session.

MessageOptions() - Constructor for class com.github.copilot.sdk.json.MessageOptions

messagesLength() - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Returns the value of the messagesLength record component.

messagesRemoved() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the messagesRemoved record component.

messagesRemovedDuringTruncation() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the messagesRemovedDuringTruncation record component.

metadata() - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Returns the value of the metadata record component.

mimeType() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns the value of the mimeType record component.

model() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the model record component.

ModelBilling - Class in com.github.copilot.sdk.json

Model billing information.

ModelBilling() - Constructor for class com.github.copilot.sdk.json.ModelBilling

ModelCapabilities - Class in com.github.copilot.sdk.json

Model capabilities and limits.

ModelCapabilities() - Constructor for class com.github.copilot.sdk.json.ModelCapabilities

ModelInfo - Class in com.github.copilot.sdk.json

Information about an available model.

ModelInfo() - Constructor for class com.github.copilot.sdk.json.ModelInfo

ModelLimits - Class in com.github.copilot.sdk.json

Model limits.

ModelLimits() - Constructor for class com.github.copilot.sdk.json.ModelLimits

modelMetrics() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the modelMetrics record component.

ModelPolicy - Class in com.github.copilot.sdk.json

Model policy state.

ModelPolicy() - Constructor for class com.github.copilot.sdk.json.ModelPolicy

ModelSupports - Class in com.github.copilot.sdk.json

Model support flags.

ModelSupports() - Constructor for class com.github.copilot.sdk.json.ModelSupports

ModelVisionLimits - Class in com.github.copilot.sdk.json

Model vision-specific limits.

ModelVisionLimits() - Constructor for class com.github.copilot.sdk.json.ModelVisionLimits

modifiedArgs() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns the value of the modifiedArgs record component.

modifiedConfig() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput

Returns the value of the modifiedConfig record component.

modifiedPrompt() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Returns the value of the modifiedPrompt record component.

modifiedResult() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Returns the value of the modifiedResult record component.

modifiedTime() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Returns the value of the modifiedTime record component.

N

name() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Returns the value of the name record component.

name() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Returns the value of the name record component.

name() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns the value of the name record component.

name() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns the value of the name record component.

newModel() - Method in record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Returns the value of the newModel record component.

O

on(Class<T>, Consumer<T>) - Method in class com.github.copilot.sdk.CopilotSession

Registers an event handler for a specific event type.

on(Consumer<AbstractSessionEvent>) - Method in class com.github.copilot.sdk.CopilotSession

Registers a callback for all session events.

onLifecycle(SessionLifecycleHandler) - Method in class com.github.copilot.sdk.CopilotClient

Subscribes to all session lifecycle events.

onLifecycle(String, SessionLifecycleHandler) - Method in class com.github.copilot.sdk.CopilotClient

Subscribes to a specific session lifecycle event type.

onLifecycleEvent(SessionLifecycleEvent) - Method in interface com.github.copilot.sdk.json.SessionLifecycleHandler

Called when a session lifecycle event occurs.

output() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns the value of the output record component.

output() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Returns the value of the output record component.

outputTokens() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the outputTokens record component.

owner() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Returns the value of the owner record component.

P

parameters() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns the value of the parameters record component.

parentToolCallId() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns the value of the parentToolCallId record component.

parentToolCallId() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the parentToolCallId record component.

parentToolCallId() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the parentToolCallId record component.

parentToolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the parentToolCallId record component.

parentToolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the parentToolCallId record component.

parse(JsonNode) - Static method in class com.github.copilot.sdk.events.SessionEventParser

Parses a JsonNode into the appropriate SessionEvent subclass.

partialOutput() - Method in record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Returns the value of the partialOutput record component.

path() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns the value of the path record component.

path() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the path record component.

path() - Method in record class com.github.copilot.sdk.json.Attachment

Returns the value of the path record component.

PendingMessagesModifiedData() - Constructor for record class com.github.copilot.sdk.events.PendingMessagesModifiedEvent.PendingMessagesModifiedData

Creates an instance of a PendingMessagesModifiedData record class.

PendingMessagesModifiedEvent - Class in com.github.copilot.sdk.events

Event: pending_messages.modified

PendingMessagesModifiedEvent() - Constructor for class com.github.copilot.sdk.events.PendingMessagesModifiedEvent

PendingMessagesModifiedEvent.PendingMessagesModifiedData - Record Class in com.github.copilot.sdk.events

performedBy() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the performedBy record component.

permissionDecision() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns the value of the permissionDecision record component.

permissionDecisionReason() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns the value of the permissionDecisionReason record component.

PermissionHandler - Interface in com.github.copilot.sdk.json

Functional interface for handling permission requests from the AI assistant.

PermissionInvocation - Class in com.github.copilot.sdk.json

Context information for a permission request invocation.

PermissionInvocation() - Constructor for class com.github.copilot.sdk.json.PermissionInvocation

PermissionRequest - Class in com.github.copilot.sdk.json

Represents a permission request from the AI assistant.

PermissionRequest() - Constructor for class com.github.copilot.sdk.json.PermissionRequest

PermissionRequestResult - Class in com.github.copilot.sdk.json

Result of a permission request decision.

PermissionRequestResult() - Constructor for class com.github.copilot.sdk.json.PermissionRequestResult

ping(String) - Method in class com.github.copilot.sdk.CopilotClient

Pings the server to check connectivity.

PingResponse - Record Class in com.github.copilot.sdk.json

Response from a ping request to the Copilot CLI server.

PingResponse(String, long, Integer) - Constructor for record class com.github.copilot.sdk.json.PingResponse

Creates an instance of a PingResponse record class.

Position(int, int) - Constructor for record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Creates an instance of a Position record class.

postCompactionTokens() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the postCompactionTokens record component.

PostToolUseHandler - Interface in com.github.copilot.sdk.json

Handler for post-tool-use hooks.

PostToolUseHookInput - Class in com.github.copilot.sdk.json

Input for a post-tool-use hook.

PostToolUseHookInput() - Constructor for class com.github.copilot.sdk.json.PostToolUseHookInput

PostToolUseHookOutput - Record Class in com.github.copilot.sdk.json

Output for a post-tool-use hook.

PostToolUseHookOutput(JsonNode, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.PostToolUseHookOutput

Creates an instance of a PostToolUseHookOutput record class.

postTruncationMessagesLength() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the postTruncationMessagesLength record component.

postTruncationTokensInMessages() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the postTruncationTokensInMessages record component.

preCompactionMessagesLength() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the preCompactionMessagesLength record component.

preCompactionTokens() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the preCompactionTokens record component.

PreToolUseHandler - Interface in com.github.copilot.sdk.json

Handler for pre-tool-use hooks.

PreToolUseHookInput - Class in com.github.copilot.sdk.json

Input for a pre-tool-use hook.

PreToolUseHookInput() - Constructor for class com.github.copilot.sdk.json.PreToolUseHookInput

PreToolUseHookOutput - Record Class in com.github.copilot.sdk.json

Output for a pre-tool-use hook.

PreToolUseHookOutput(String, String, JsonNode, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an instance of a PreToolUseHookOutput record class.

preTruncationMessagesLength() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the preTruncationMessagesLength record component.

preTruncationTokensInMessages() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the preTruncationTokensInMessages record component.

previousModel() - Method in record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Returns the value of the previousModel record component.

producer() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the producer record component.

progressMessage() - Method in record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Returns the value of the progressMessage record component.

prompt() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Returns the value of the prompt record component.

PROPAGATE_AND_LOG_ERRORS - Enum constant in enum class com.github.copilot.sdk.EventErrorPolicy

Propagate errors: log the error and stop dispatch on first listener error (default).

protocolVersion() - Method in record class com.github.copilot.sdk.json.PingResponse

Returns the value of the protocolVersion record component.

providerCallId() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns the value of the providerCallId record component.

providerCallId() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns the value of the providerCallId record component.

ProviderConfig - Class in com.github.copilot.sdk.json

Configuration for a custom API provider (BYOK - Bring Your Own Key).

ProviderConfig() - Constructor for class com.github.copilot.sdk.json.ProviderConfig

Q

quotaSnapshots() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns a defensive copy of the quota snapshots map.

R

reason() - Method in record class com.github.copilot.sdk.events.AbortEvent.AbortData

Returns the value of the reason record component.

reason() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns the value of the reason record component.

reasoningId() - Method in record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Returns the value of the reasoningId record component.

reasoningId() - Method in record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Returns the value of the reasoningId record component.

reasoningOpaque() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the reasoningOpaque record component.

reasoningText() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns the value of the reasoningText record component.

remoteSessionId() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the remoteSessionId record component.

REPLACE - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode

Replace the default system message entirely with the custom content.

repository() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the repository record component.

Repository(String, String, String) - Constructor for record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Creates an instance of a Repository record class.

requestId() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the requestId record component.

result() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the result record component.

Result(String, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Creates an instance of a Result record class.

resultType() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the resultType record component.

resumeSession(String) - Method in class com.github.copilot.sdk.CopilotClient

Resumes an existing session with default configuration.

resumeSession(String, ResumeSessionConfig) - Method in class com.github.copilot.sdk.CopilotClient

Resumes an existing Copilot session.

ResumeSessionConfig - Class in com.github.copilot.sdk.json

Configuration for resuming an existing Copilot session.

ResumeSessionConfig() - Constructor for class com.github.copilot.sdk.json.ResumeSessionConfig

ResumeSessionRequest - Class in com.github.copilot.sdk.json

Internal request object for resuming an existing session.

ResumeSessionRequest() - Constructor for class com.github.copilot.sdk.json.ResumeSessionRequest

ResumeSessionResponse - Record Class in com.github.copilot.sdk.json

Internal response object from resuming a session.

ResumeSessionResponse(String, String) - Constructor for record class com.github.copilot.sdk.json.ResumeSessionResponse

Creates an instance of a ResumeSessionResponse record class.

resumeTime() - Method in record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Returns the value of the resumeTime record component.

ROUTINE - Enum constant in enum class com.github.copilot.sdk.events.SessionShutdownEvent.ShutdownType

S

SdkProtocolVersion - Enum Class in com.github.copilot.sdk

Provides the SDK protocol version.

selectedModel() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the selectedModel record component.

selection() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the selection record component.

Selection(UserMessageEvent.UserMessageData.Attachment.Selection.Position, UserMessageEvent.UserMessageData.Attachment.Selection.Position) - Constructor for record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Creates an instance of a Selection record class.

send(MessageOptions) - Method in class com.github.copilot.sdk.CopilotSession

Sends a message to the Copilot session.

send(String) - Method in class com.github.copilot.sdk.CopilotSession

Sends a simple text message to the Copilot session.

sendAndWait(MessageOptions) - Method in class com.github.copilot.sdk.CopilotSession

Sends a message and waits until the session becomes idle with default 60 second timeout.

sendAndWait(MessageOptions, long) - Method in class com.github.copilot.sdk.CopilotSession

Sends a message and waits until the session becomes idle.

sendAndWait(String) - Method in class com.github.copilot.sdk.CopilotSession

Sends a simple text message and waits until the session becomes idle.

SendMessageRequest - Class in com.github.copilot.sdk.json

Internal request object for sending a message to a session.

SendMessageRequest() - Constructor for class com.github.copilot.sdk.json.SendMessageRequest

SendMessageResponse - Record Class in com.github.copilot.sdk.json

Internal response object from sending a message.

SendMessageResponse(String) - Constructor for record class com.github.copilot.sdk.json.SendMessageResponse

Creates an instance of a SendMessageResponse record class.

SessionCompactionCompleteData(boolean, String, Double, Double, Double, Double, Double, String, Double, String, SessionCompactionCompleteEvent.CompactionTokensUsed, String) - Constructor for record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Creates an instance of a SessionCompactionCompleteData record class.

SessionCompactionCompleteEvent - Class in com.github.copilot.sdk.events

Event: session.compaction_complete

SessionCompactionCompleteEvent() - Constructor for class com.github.copilot.sdk.events.SessionCompactionCompleteEvent

SessionCompactionCompleteEvent.CompactionTokensUsed - Record Class in com.github.copilot.sdk.events

Token usage information for the compaction operation.

SessionCompactionCompleteEvent.SessionCompactionCompleteData - Record Class in com.github.copilot.sdk.events

SessionCompactionStartData() - Constructor for record class com.github.copilot.sdk.events.SessionCompactionStartEvent.SessionCompactionStartData

Creates an instance of a SessionCompactionStartData record class.

SessionCompactionStartEvent - Class in com.github.copilot.sdk.events

Event: session.compaction_start

SessionCompactionStartEvent() - Constructor for class com.github.copilot.sdk.events.SessionCompactionStartEvent

SessionCompactionStartEvent.SessionCompactionStartData - Record Class in com.github.copilot.sdk.events

SessionConfig - Class in com.github.copilot.sdk.json

Configuration for creating a new Copilot session.

SessionConfig() - Constructor for class com.github.copilot.sdk.json.SessionConfig

SessionContext - Class in com.github.copilot.sdk.json

Working directory context for a session.

SessionContext() - Constructor for class com.github.copilot.sdk.json.SessionContext

SessionContextChangedEvent - Class in com.github.copilot.sdk.events

Event: session.context_changed

SessionContextChangedEvent() - Constructor for class com.github.copilot.sdk.events.SessionContextChangedEvent

SessionEndHandler - Interface in com.github.copilot.sdk.json

Handler for session-end hooks.

SessionEndHookInput - Record Class in com.github.copilot.sdk.json

Input for a session-end hook.

SessionEndHookInput(long, String, String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionEndHookInput

Creates an instance of a SessionEndHookInput record class.

SessionEndHookOutput - Record Class in com.github.copilot.sdk.json

Output for a session-end hook.

SessionEndHookOutput(Boolean, List<String>, String) - Constructor for record class com.github.copilot.sdk.json.SessionEndHookOutput

Creates an instance of a SessionEndHookOutput record class.

SessionErrorData(String, String, String, Double, String) - Constructor for record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Creates an instance of a SessionErrorData record class.

SessionErrorEvent - Class in com.github.copilot.sdk.events

Event: session.error

SessionErrorEvent() - Constructor for class com.github.copilot.sdk.events.SessionErrorEvent

SessionErrorEvent.SessionErrorData - Record Class in com.github.copilot.sdk.events

SessionEventParser - Class in com.github.copilot.sdk.events

Parser for session events that handles polymorphic deserialization.

SessionEventParser() - Constructor for class com.github.copilot.sdk.events.SessionEventParser

SessionHandoffData(OffsetDateTime, String, SessionHandoffEvent.SessionHandoffData.Repository, String, String, String) - Constructor for record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Creates an instance of a SessionHandoffData record class.

SessionHandoffEvent - Class in com.github.copilot.sdk.events

Event: session.handoff

SessionHandoffEvent() - Constructor for class com.github.copilot.sdk.events.SessionHandoffEvent

SessionHandoffEvent.SessionHandoffData - Record Class in com.github.copilot.sdk.events

SessionHandoffEvent.SessionHandoffData.Repository - Record Class in com.github.copilot.sdk.events

SessionHooks - Class in com.github.copilot.sdk.json

Hook handlers configuration for a session.

SessionHooks() - Constructor for class com.github.copilot.sdk.json.SessionHooks

sessionId() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the sessionId record component.

sessionId() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse

Returns the value of the sessionId record component.

sessionId() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Returns the value of the sessionId record component.

sessionId() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse

Returns the value of the sessionId record component.

sessionId() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse

Returns the value of the sessionId record component.

SessionIdleData() - Constructor for record class com.github.copilot.sdk.events.SessionIdleEvent.SessionIdleData

Creates an instance of a SessionIdleData record class.

SessionIdleEvent - Class in com.github.copilot.sdk.events

Event: session.idle

SessionIdleEvent() - Constructor for class com.github.copilot.sdk.events.SessionIdleEvent

SessionIdleEvent.SessionIdleData - Record Class in com.github.copilot.sdk.events

SessionInfoData(String, String) - Constructor for record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Creates an instance of a SessionInfoData record class.

SessionInfoEvent - Class in com.github.copilot.sdk.events

Event: session.info

SessionInfoEvent() - Constructor for class com.github.copilot.sdk.events.SessionInfoEvent

SessionInfoEvent.SessionInfoData - Record Class in com.github.copilot.sdk.events

SessionLifecycleEvent - Class in com.github.copilot.sdk.json

Session lifecycle event notification.

SessionLifecycleEvent() - Constructor for class com.github.copilot.sdk.json.SessionLifecycleEvent

SessionLifecycleEventMetadata - Record Class in com.github.copilot.sdk.json

Metadata for session lifecycle events.

SessionLifecycleEventMetadata(String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Creates an instance of a SessionLifecycleEventMetadata record class.

SessionLifecycleEventTypes - Class in com.github.copilot.sdk.json

Types of session lifecycle events.

SessionLifecycleHandler - Interface in com.github.copilot.sdk.json

Handler for session lifecycle events.

SessionListFilter - Class in com.github.copilot.sdk.json

Filter options for listing sessions.

SessionListFilter() - Constructor for class com.github.copilot.sdk.json.SessionListFilter

sessionLog() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the sessionLog record component.

SessionMetadata - Class in com.github.copilot.sdk.json

Metadata about an existing Copilot session.

SessionMetadata() - Constructor for class com.github.copilot.sdk.json.SessionMetadata

SessionModelChangeData(String, String) - Constructor for record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Creates an instance of a SessionModelChangeData record class.

SessionModelChangeEvent - Class in com.github.copilot.sdk.events

Event: session.model_change

SessionModelChangeEvent() - Constructor for class com.github.copilot.sdk.events.SessionModelChangeEvent

SessionModelChangeEvent.SessionModelChangeData - Record Class in com.github.copilot.sdk.events

SessionResumeData(OffsetDateTime, double) - Constructor for record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Creates an instance of a SessionResumeData record class.

SessionResumeEvent - Class in com.github.copilot.sdk.events

Event: session.resume

SessionResumeEvent() - Constructor for class com.github.copilot.sdk.events.SessionResumeEvent

SessionResumeEvent.SessionResumeData - Record Class in com.github.copilot.sdk.events

sessions() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse

Returns the value of the sessions record component.

SessionShutdownData(SessionShutdownEvent.ShutdownType, String, double, double, double, SessionShutdownEvent.CodeChanges, Map<String, Object>, String) - Constructor for record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Creates an instance of a SessionShutdownData record class.

SessionShutdownEvent - Class in com.github.copilot.sdk.events

Event: session.shutdown

SessionShutdownEvent() - Constructor for class com.github.copilot.sdk.events.SessionShutdownEvent

SessionShutdownEvent.CodeChanges - Record Class in com.github.copilot.sdk.events

Code changes made during the session.

SessionShutdownEvent.SessionShutdownData - Record Class in com.github.copilot.sdk.events

Data for the session shutdown event.

SessionShutdownEvent.ShutdownType - Enum Class in com.github.copilot.sdk.events

Type of session shutdown.

SessionSnapshotRewindData(String, int) - Constructor for record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Creates an instance of a SessionSnapshotRewindData record class.

SessionSnapshotRewindEvent - Class in com.github.copilot.sdk.events

Event: session.snapshot_rewind

SessionSnapshotRewindEvent() - Constructor for class com.github.copilot.sdk.events.SessionSnapshotRewindEvent

SessionSnapshotRewindEvent.SessionSnapshotRewindData - Record Class in com.github.copilot.sdk.events

SessionStartData(String, double, String, String, OffsetDateTime, String) - Constructor for record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Creates an instance of a SessionStartData record class.

SessionStartEvent - Class in com.github.copilot.sdk.events

Event: session.start

SessionStartEvent() - Constructor for class com.github.copilot.sdk.events.SessionStartEvent

SessionStartEvent.SessionStartData - Record Class in com.github.copilot.sdk.events

SessionStartHandler - Interface in com.github.copilot.sdk.json

Handler for session-start hooks.

SessionStartHookInput - Record Class in com.github.copilot.sdk.json

Input for a session-start hook.

SessionStartHookInput(long, String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionStartHookInput

Creates an instance of a SessionStartHookInput record class.

SessionStartHookOutput - Record Class in com.github.copilot.sdk.json

Output for a session-start hook.

SessionStartHookOutput(String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.json.SessionStartHookOutput

Creates an instance of a SessionStartHookOutput record class.

sessionStartTime() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the sessionStartTime record component.

sessionSummary() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Returns the value of the sessionSummary record component.

SessionTruncationData(double, double, double, double, double, double, double, String) - Constructor for record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Creates an instance of a SessionTruncationData record class.

SessionTruncationEvent - Class in com.github.copilot.sdk.events

Event: session.truncation

SessionTruncationEvent() - Constructor for class com.github.copilot.sdk.events.SessionTruncationEvent

SessionTruncationEvent.SessionTruncationData - Record Class in com.github.copilot.sdk.events

SessionUsageInfoData(double, double, double) - Constructor for record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Creates an instance of a SessionUsageInfoData record class.

SessionUsageInfoEvent - Class in com.github.copilot.sdk.events

Event: session.usage_info

SessionUsageInfoEvent() - Constructor for class com.github.copilot.sdk.events.SessionUsageInfoEvent

SessionUsageInfoEvent.SessionUsageInfoData - Record Class in com.github.copilot.sdk.events

setAllowFreeform(Boolean) - Method in class com.github.copilot.sdk.json.UserInputRequest

Sets whether freeform text input is allowed.

setAnswer(String) - Method in class com.github.copilot.sdk.json.UserInputResponse

Sets the user's answer.

setApiKey(String) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets the API key for authentication.

setApiVersion(String) - Method in class com.github.copilot.sdk.json.AzureOptions

Sets the Azure OpenAI API version to use.

setArguments(JsonNode) - Method in class com.github.copilot.sdk.json.ToolInvocation

Sets the tool arguments.

setAttachments(List<Attachment>) - Method in class com.github.copilot.sdk.json.MessageOptions

Sets file attachments to include with the message.

setAttachments(List<Attachment>) - Method in class com.github.copilot.sdk.json.SendMessageRequest

Sets the attachments.

setAuthenticated(boolean) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

setAuthType(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

setAutoRestart(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets whether the client should automatically restart the CLI server if it crashes unexpectedly.

setAutoStart(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets whether the client should automatically start the CLI server when the first request is made.

setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets available tools.

setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the list of tool names that are allowed in this session.

setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets available tools.

setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the list of tool names that are allowed in this session.

setAzure(AzureOptions) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets Azure-specific options for Azure OpenAI Service.

setBackgroundCompactionThreshold(Double) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Sets the context utilization threshold at which background compaction starts.

setBaseUrl(String) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets the base URL for the API.

setBearerToken(String) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets a bearer token for authentication.

setBilling(ModelBilling) - Method in class com.github.copilot.sdk.json.ModelInfo

setBranch(String) - Method in class com.github.copilot.sdk.json.SessionContext

Sets the git branch.

setBranch(String) - Method in class com.github.copilot.sdk.json.SessionListFilter

Sets the filter for git branch.

setBufferExhaustionThreshold(Double) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Sets the context utilization threshold at which the session blocks until compaction completes.

setCapabilities(ModelCapabilities) - Method in class com.github.copilot.sdk.json.ModelInfo

setChoices(List<String>) - Method in class com.github.copilot.sdk.json.UserInputRequest

Sets the choices for multiple choice questions.

setCliArgs(String[]) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets extra arguments to pass to the CLI process.

setCliPath(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the path to the Copilot CLI executable.

setCliUrl(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the URL of an existing CLI server to connect to.

setCode(int) - Method in class com.github.copilot.sdk.json.JsonRpcError

Sets the error code.

setConfigDir(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets config directory.

setConfigDir(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the configuration directory path.

setConfigDir(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets config directory.

setConfigDir(String) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets a custom configuration directory for the session.

setContent(String) - Method in class com.github.copilot.sdk.json.SystemMessageConfig

Sets the system message content.

setContext(SessionContext) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets the working directory context.

setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets custom agents.

setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets custom agent configurations.

setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets custom agents.

setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets custom agent configurations.

setCwd(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the working directory for the CLI process.

setCwd(String) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Sets the current working directory.

setCwd(String) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Sets the current working directory.

setCwd(String) - Method in class com.github.copilot.sdk.json.SessionContext

Sets the working directory.

setCwd(String) - Method in class com.github.copilot.sdk.json.SessionListFilter

Sets the filter for exact cwd match.

setData(AbortEvent.AbortData) - Method in class com.github.copilot.sdk.events.AbortEvent

setData(AssistantIntentEvent.AssistantIntentData) - Method in class com.github.copilot.sdk.events.AssistantIntentEvent

setData(AssistantMessageDeltaEvent.AssistantMessageDeltaData) - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent

setData(AssistantMessageEvent.AssistantMessageData) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent

Sets the message data.

setData(AssistantReasoningDeltaEvent.AssistantReasoningDeltaData) - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent

setData(AssistantReasoningEvent.AssistantReasoningData) - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent

setData(AssistantTurnEndEvent.AssistantTurnEndData) - Method in class com.github.copilot.sdk.events.AssistantTurnEndEvent

setData(AssistantTurnStartEvent.AssistantTurnStartData) - Method in class com.github.copilot.sdk.events.AssistantTurnStartEvent

setData(AssistantUsageEvent.AssistantUsageData) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent

setData(HookEndEvent.HookEndData) - Method in class com.github.copilot.sdk.events.HookEndEvent

setData(HookStartEvent.HookStartData) - Method in class com.github.copilot.sdk.events.HookStartEvent

setData(PendingMessagesModifiedEvent.PendingMessagesModifiedData) - Method in class com.github.copilot.sdk.events.PendingMessagesModifiedEvent

setData(SessionCompactionCompleteEvent.SessionCompactionCompleteData) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent

setData(SessionCompactionStartEvent.SessionCompactionStartData) - Method in class com.github.copilot.sdk.events.SessionCompactionStartEvent

setData(SessionErrorEvent.SessionErrorData) - Method in class com.github.copilot.sdk.events.SessionErrorEvent

setData(SessionHandoffEvent.SessionHandoffData) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent

setData(SessionIdleEvent.SessionIdleData) - Method in class com.github.copilot.sdk.events.SessionIdleEvent

setData(SessionInfoEvent.SessionInfoData) - Method in class com.github.copilot.sdk.events.SessionInfoEvent

setData(SessionModelChangeEvent.SessionModelChangeData) - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent

setData(SessionResumeEvent.SessionResumeData) - Method in class com.github.copilot.sdk.events.SessionResumeEvent

setData(SessionShutdownEvent.SessionShutdownData) - Method in class com.github.copilot.sdk.events.SessionShutdownEvent

setData(SessionSnapshotRewindEvent.SessionSnapshotRewindData) - Method in class com.github.copilot.sdk.events.SessionSnapshotRewindEvent

setData(SessionStartEvent.SessionStartData) - Method in class com.github.copilot.sdk.events.SessionStartEvent

setData(SessionTruncationEvent.SessionTruncationData) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent

setData(SessionUsageInfoEvent.SessionUsageInfoData) - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent

setData(SkillInvokedEvent.SkillInvokedData) - Method in class com.github.copilot.sdk.events.SkillInvokedEvent

setData(SubagentCompletedEvent.SubagentCompletedData) - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent

setData(SubagentFailedEvent.SubagentFailedData) - Method in class com.github.copilot.sdk.events.SubagentFailedEvent

setData(SubagentSelectedEvent.SubagentSelectedData) - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent

setData(SubagentStartedEvent.SubagentStartedData) - Method in class com.github.copilot.sdk.events.SubagentStartedEvent

setData(SystemMessageEvent.SystemMessageData) - Method in class com.github.copilot.sdk.events.SystemMessageEvent

setData(ToolExecutionCompleteEvent.ToolExecutionCompleteData) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent

setData(ToolExecutionPartialResultEvent.ToolExecutionPartialResultData) - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent

setData(ToolExecutionProgressEvent.ToolExecutionProgressData) - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent

setData(ToolExecutionStartEvent.ToolExecutionStartData) - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent

setData(ToolUserRequestedEvent.ToolUserRequestedData) - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent

setData(UserMessageEvent.UserMessageData) - Method in class com.github.copilot.sdk.events.UserMessageEvent

setData(SessionContext) - Method in class com.github.copilot.sdk.events.SessionContextChangedEvent

setData(Object) - Method in class com.github.copilot.sdk.json.JsonRpcError

Sets the additional error data.

setDefaultReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ModelInfo

Sets the default reasoning effort level.

setDescription(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets a description of the agent's capabilities.

setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets disabled skills.

setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets skills that should be disabled for this session.

setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets disabled skills.

setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the list of skill names to disable.

setDisableResume(boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets whether to disable the session.resume event.

setDisableResume(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets disable resume flag.

setDisplayName(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets the human-readable display name.

setEnabled(Boolean) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig

Sets whether infinite sessions are enabled.

setEnvironment(Map<String, String>) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets environment variables to pass to the CLI process.

setEphemeral(Boolean) - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Sets whether this is an ephemeral event.

setError(JsonRpcError) - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Sets the error for a failed RPC call.

setEventErrorHandler(EventErrorHandler) - Method in class com.github.copilot.sdk.CopilotSession

Sets a custom error handler for exceptions thrown by event handlers.

setEventErrorPolicy(EventErrorPolicy) - Method in class com.github.copilot.sdk.CopilotSession

Sets the error propagation policy for event dispatch.

setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets excluded tools.

setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the list of tool names to exclude from this session.

setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets excluded tools.

setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the list of tool names to exclude from this session.

setExtensionData(Map<String, Object>) - Method in class com.github.copilot.sdk.json.PermissionRequest

Sets additional extension data for the request.

setForegroundSessionId(String) - Method in class com.github.copilot.sdk.CopilotClient

Requests the TUI to switch to displaying the specified session.

SetForegroundSessionResponse - Record Class in com.github.copilot.sdk.json

Response from session.setForeground RPC call.

SetForegroundSessionResponse(boolean, String) - Constructor for record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Creates an instance of a SetForegroundSessionResponse record class.

setGithubToken(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the GitHub token to use for authentication.

setGitRoot(String) - Method in class com.github.copilot.sdk.json.SessionContext

Sets the git repository root directory.

setGitRoot(String) - Method in class com.github.copilot.sdk.json.SessionListFilter

Sets the filter for git root directory.

setHooks(SessionHooks) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets hook handlers for session lifecycle events.

setHooks(SessionHooks) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets hook handlers for session lifecycle events.

setHooks(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets hooks flag.

setHooks(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets hooks flag.

setHost(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

setId(Long) - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Sets the request ID.

setId(Object) - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Sets the response ID.

setId(String) - Method in class com.github.copilot.sdk.json.ModelInfo

setId(UUID) - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Sets the event identifier.

setInfer(Boolean) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets whether to enable inference mode for this agent.

setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets infinite sessions config.

setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the infinite session configuration for persistent workspaces and automatic compaction.

setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets infinite sessions config.

setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the infinite session configuration for persistent workspaces and automatic compaction.

setJsonrpc(String) - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Sets the JSON-RPC version.

setJsonrpc(String) - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Sets the JSON-RPC version.

setKind(String) - Method in class com.github.copilot.sdk.json.PermissionRequest

Sets the permission kind.

setKind(String) - Method in class com.github.copilot.sdk.json.PermissionRequestResult

Sets the result kind.

setLimits(ModelLimits) - Method in class com.github.copilot.sdk.json.ModelCapabilities

setLogin(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

setLogLevel(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the log level for the CLI process.

setMaxContextWindowTokens(int) - Method in class com.github.copilot.sdk.json.ModelLimits

setMaxPromptImages(int) - Method in class com.github.copilot.sdk.json.ModelVisionLimits

setMaxPromptImageSize(int) - Method in class com.github.copilot.sdk.json.ModelVisionLimits

setMaxPromptTokens(Integer) - Method in class com.github.copilot.sdk.json.ModelLimits

setMcpServers(Map<String, Object>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets MCP servers.

setMcpServers(Map<String, Object>) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets MCP (Model Context Protocol) servers available to this agent.

setMcpServers(Map<String, Object>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets MCP (Model Context Protocol) server configurations.

setMcpServers(Map<String, Object>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets MCP servers.

setMcpServers(Map<String, Object>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets MCP (Model Context Protocol) server configurations.

setMessage(String) - Method in class com.github.copilot.sdk.json.JsonRpcError

Sets the error message.

setMetadata(SessionLifecycleEventMetadata) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

setMethod(String) - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Sets the method name.

setMode(SystemMessageMode) - Method in class com.github.copilot.sdk.json.SystemMessageConfig

Sets the system message mode.

setMode(String) - Method in class com.github.copilot.sdk.json.MessageOptions

Sets the message delivery mode.

setMode(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest

Sets the mode.

setModel(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the model name.

setModel(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the AI model to use for the resumed session.

setModel(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the model name.

setModel(String) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the AI model to use for this session.

setModels(List<ModelInfo>) - Method in class com.github.copilot.sdk.json.GetModelsResponse

setModifiedTime(String) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets the session modified time.

setMultiplier(double) - Method in class com.github.copilot.sdk.json.ModelBilling

setName(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets the unique identifier name for this agent.

setName(String) - Method in class com.github.copilot.sdk.json.ModelInfo

setOnPermissionRequest(PermissionHandler) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets a handler for permission requests from the assistant.

setOnPermissionRequest(PermissionHandler) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets a handler for permission requests from the assistant.

setOnPostToolUse(PostToolUseHandler) - Method in class com.github.copilot.sdk.json.SessionHooks

Sets the handler called after a tool has been executed.

setOnPreToolUse(PreToolUseHandler) - Method in class com.github.copilot.sdk.json.SessionHooks

Sets the handler called before a tool is executed.

setOnSessionEnd(SessionEndHandler) - Method in class com.github.copilot.sdk.json.SessionHooks

Sets the handler called when a session ends.

setOnSessionStart(SessionStartHandler) - Method in class com.github.copilot.sdk.json.SessionHooks

Sets the handler called when a session starts.

setOnUserInputRequest(UserInputHandler) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets a handler for user input requests from the agent.

setOnUserInputRequest(UserInputHandler) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets a handler for user input requests from the agent.

setOnUserPromptSubmitted(UserPromptSubmittedHandler) - Method in class com.github.copilot.sdk.json.SessionHooks

Sets the handler called when the user submits a prompt.

setParams(Object) - Method in class com.github.copilot.sdk.json.JsonRpcRequest

Sets the method parameters.

setParentId(UUID) - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Sets the parent event ID.

setPolicy(ModelPolicy) - Method in class com.github.copilot.sdk.json.ModelInfo

setPort(int) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets the TCP port for the CLI server to listen on.

setPrompt(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets the system prompt that defines this agent's behavior.

setPrompt(String) - Method in class com.github.copilot.sdk.json.MessageOptions

Sets the message prompt to send to the assistant.

setPrompt(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest

Sets the message prompt.

setProtocolVersion(int) - Method in class com.github.copilot.sdk.json.GetStatusResponse

setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the provider config.

setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets a custom API provider for BYOK scenarios.

setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the provider config.

setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets a custom API provider for BYOK (Bring Your Own Key) scenarios.

setQuestion(String) - Method in class com.github.copilot.sdk.json.UserInputRequest

Sets the question to ask the user.

setReasoningEffort(boolean) - Method in class com.github.copilot.sdk.json.ModelSupports

Sets whether this model supports reasoning effort configuration.

setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the reasoning effort.

setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the reasoning effort level for models that support it.

setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the reasoning effort.

setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the reasoning effort level for models that support it.

setRemote(boolean) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets whether this session is stored remotely.

setRepository(String) - Method in class com.github.copilot.sdk.json.SessionContext

Sets the GitHub repository.

setRepository(String) - Method in class com.github.copilot.sdk.json.SessionListFilter

Sets the filter for repository (in "owner/repo" format).

setRequestPermission(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets request permission flag.

setRequestPermission(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets request permission flag.

setRequestUserInput(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets request user input flag.

setRequestUserInput(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets request user input flag.

setResult(Object) - Method in class com.github.copilot.sdk.json.JsonRpcResponse

Sets the result of the RPC call.

setRules(List<Object>) - Method in class com.github.copilot.sdk.json.PermissionRequestResult

Sets approval rules for future similar requests.

setSessionId(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.HookInvocation

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.PermissionInvocation

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets a custom session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets the session identifier.

setSessionId(String) - Method in class com.github.copilot.sdk.json.ToolInvocation

Sets the session ID.

setSessionId(String) - Method in class com.github.copilot.sdk.json.UserInputInvocation

Sets the session ID.

setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets skill directories.

setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets directories containing skill definitions.

setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets skill directories.

setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the skill directories for loading custom skills.

setStartTime(String) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets the session start time.

setState(String) - Method in class com.github.copilot.sdk.json.ModelPolicy

setStatusMessage(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse

setStreaming(boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets whether to enable streaming of response chunks.

setStreaming(boolean) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets whether to enable streaming of response chunks.

setStreaming(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets streaming flag.

setStreaming(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets streaming flag.

setSummary(String) - Method in class com.github.copilot.sdk.json.SessionMetadata

Sets the session summary.

setSupportedMediaTypes(List<String>) - Method in class com.github.copilot.sdk.json.ModelVisionLimits

setSupportedReasoningEfforts(List<String>) - Method in class com.github.copilot.sdk.json.ModelInfo

Sets the supported reasoning effort levels.

setSupports(ModelSupports) - Method in class com.github.copilot.sdk.json.ModelCapabilities

setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the system message config.

setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the system message configuration.

setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the system message config.

setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the system message configuration.

setTerms(String) - Method in class com.github.copilot.sdk.json.ModelPolicy

setTimestamp(long) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Sets the timestamp of the hook invocation.

setTimestamp(long) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Sets the timestamp of the hook invocation.

setTimestamp(OffsetDateTime) - Method in class com.github.copilot.sdk.events.AbstractSessionEvent

Sets the event timestamp.

setToolArgs(JsonNode) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Sets the arguments passed to the tool.

setToolArgs(JsonNode) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Sets the arguments passed to the tool.

setToolCallId(String) - Method in class com.github.copilot.sdk.json.PermissionRequest

Sets the tool call ID.

setToolCallId(String) - Method in class com.github.copilot.sdk.json.ToolInvocation

Sets the tool call ID.

setToolName(String) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Sets the name of the tool that was invoked.

setToolName(String) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput

Sets the name of the tool being invoked.

setToolName(String) - Method in class com.github.copilot.sdk.json.ToolInvocation

Sets the tool name.

setToolResult(JsonNode) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput

Sets the result returned by the tool.

setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets the tools.

setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets custom tools that the assistant can invoke during the session.

setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets the tools.

setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets custom tools that the assistant can invoke during the session.

setTools(List<String>) - Method in class com.github.copilot.sdk.json.CustomAgentConfig

Sets the tools available to this agent.

setType(String) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets the provider type.

setType(String) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent

setUseLoggedInUser(Boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets whether to use the logged-in user for authentication.

setUseStdio(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions

Sets whether to use stdio transport instead of TCP.

setVersion(String) - Method in class com.github.copilot.sdk.json.GetStatusResponse

setVision(boolean) - Method in class com.github.copilot.sdk.json.ModelSupports

setVision(ModelVisionLimits) - Method in class com.github.copilot.sdk.json.ModelLimits

setWasFreeform(boolean) - Method in class com.github.copilot.sdk.json.UserInputResponse

Sets whether the answer was freeform.

setWireApi(String) - Method in class com.github.copilot.sdk.json.ProviderConfig

Sets the wire API format for custom providers.

setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest

Sets working directory.

setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig

Sets the working directory for the session.

setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest

Sets working directory.

setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.SessionConfig

Sets the working directory for the session.

shutdownType() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the shutdownType record component.

SkillInvokedData(String, String, String, List<String>) - Constructor for record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Creates an instance of a SkillInvokedData record class.

SkillInvokedEvent - Class in com.github.copilot.sdk.events

Event: skill.invoked

SkillInvokedEvent() - Constructor for class com.github.copilot.sdk.events.SkillInvokedEvent

SkillInvokedEvent.SkillInvokedData - Record Class in com.github.copilot.sdk.events

Data for the skill invoked event.

source() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns the value of the source record component.

source() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns the value of the source record component.

sourceType() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the sourceType record component.

stack() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Returns the value of the stack record component.

stack() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns the value of the stack record component.

start() - Method in class com.github.copilot.sdk.CopilotClient

Starts the Copilot client and connects to the server.

start() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Returns the value of the start record component.

startTime() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the startTime record component.

startTime() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Returns the value of the startTime record component.

statusCode() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns the value of the statusCode record component.

stop() - Method in class com.github.copilot.sdk.CopilotClient

Stops the client and closes all sessions.

SubagentCompletedData(String, String) - Constructor for record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Creates an instance of a SubagentCompletedData record class.

SubagentCompletedEvent - Class in com.github.copilot.sdk.events

Event: subagent.completed

SubagentCompletedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentCompletedEvent

SubagentCompletedEvent.SubagentCompletedData - Record Class in com.github.copilot.sdk.events

SubagentFailedData(String, String, String) - Constructor for record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Creates an instance of a SubagentFailedData record class.

SubagentFailedEvent - Class in com.github.copilot.sdk.events

Event: subagent.failed

SubagentFailedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentFailedEvent

SubagentFailedEvent.SubagentFailedData - Record Class in com.github.copilot.sdk.events

SubagentSelectedData(String, String, String[]) - Constructor for record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Creates an instance of a SubagentSelectedData record class.

SubagentSelectedEvent - Class in com.github.copilot.sdk.events

Event: subagent.selected

SubagentSelectedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentSelectedEvent

SubagentSelectedEvent.SubagentSelectedData - Record Class in com.github.copilot.sdk.events

SubagentStartedData(String, String, String, String) - Constructor for record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Creates an instance of a SubagentStartedData record class.

SubagentStartedEvent - Class in com.github.copilot.sdk.events

Event: subagent.started

SubagentStartedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentStartedEvent

SubagentStartedEvent.SubagentStartedData - Record Class in com.github.copilot.sdk.events

success() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns the value of the success record component.

success() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the success record component.

success() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the success record component.

success() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse

Returns the value of the success record component.

success() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Returns the value of the success record component.

success(String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject

Creates a success result with the given text.

summary() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns the value of the summary record component.

summary() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Returns the value of the summary record component.

summaryContent() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the summaryContent record component.

SUPPRESS_AND_LOG_ERRORS - Enum constant in enum class com.github.copilot.sdk.EventErrorPolicy

Suppress errors: log the error and continue dispatching to remaining listeners.

suppressOutput() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Returns the value of the suppressOutput record component.

suppressOutput() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns the value of the suppressOutput record component.

suppressOutput() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Returns the value of the suppressOutput record component.

suppressOutput() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Returns the value of the suppressOutput record component.

SystemMessageConfig - Class in com.github.copilot.sdk.json

Configuration for customizing the system message.

SystemMessageConfig() - Constructor for class com.github.copilot.sdk.json.SystemMessageConfig

SystemMessageData(String, String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Creates an instance of a SystemMessageData record class.

SystemMessageEvent - Class in com.github.copilot.sdk.events

Event: system.message

SystemMessageEvent() - Constructor for class com.github.copilot.sdk.events.SystemMessageEvent

SystemMessageEvent.SystemMessageData - Record Class in com.github.copilot.sdk.events

SystemMessageMode - Enum Class in com.github.copilot.sdk

Specifies how the system message should be applied to a session.

T

text() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the text record component.

textResultForLlm() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the textResultForLlm record component.

timestamp() - Method in record class com.github.copilot.sdk.json.PingResponse

Returns the value of the timestamp record component.

timestamp() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns the value of the timestamp record component.

timestamp() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns the value of the timestamp record component.

timestamp() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Returns the value of the timestamp record component.

tokenLimit() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the tokenLimit record component.

tokenLimit() - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Returns the value of the tokenLimit record component.

tokensRemoved() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns the value of the tokensRemoved record component.

tokensRemovedDuringTruncation() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns the value of the tokensRemovedDuringTruncation record component.

ToolBinaryResult - Record Class in com.github.copilot.sdk.json

Binary result from a tool execution.

ToolBinaryResult(String, String, String, String) - Constructor for record class com.github.copilot.sdk.json.ToolBinaryResult

Creates an instance of a ToolBinaryResult record class.

toolCallId() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the toolCallId record component.

toolCallId() - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Returns the value of the toolCallId record component.

ToolDefinition - Record Class in com.github.copilot.sdk.json

Defines a tool that can be invoked by the AI assistant.

ToolDefinition(String, String, Object, ToolHandler) - Constructor for record class com.github.copilot.sdk.json.ToolDefinition

Creates an instance of a ToolDefinition record class.

ToolExecutionCompleteData(String, boolean, Boolean, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error, Map<String, Object>, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Creates an instance of a ToolExecutionCompleteData record class.

ToolExecutionCompleteEvent - Class in com.github.copilot.sdk.events

Event: tool.execution_complete

ToolExecutionCompleteEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionCompleteEvent

ToolExecutionCompleteEvent.ToolExecutionCompleteData - Record Class in com.github.copilot.sdk.events

ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error - Record Class in com.github.copilot.sdk.events

ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result - Record Class in com.github.copilot.sdk.events

ToolExecutionPartialResultData(String, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Creates an instance of a ToolExecutionPartialResultData record class.

ToolExecutionPartialResultEvent - Class in com.github.copilot.sdk.events

Event: tool.execution_partial_result

ToolExecutionPartialResultEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent

ToolExecutionPartialResultEvent.ToolExecutionPartialResultData - Record Class in com.github.copilot.sdk.events

ToolExecutionProgressData(String, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Creates an instance of a ToolExecutionProgressData record class.

ToolExecutionProgressEvent - Class in com.github.copilot.sdk.events

Event fired when a tool execution reports progress.

ToolExecutionProgressEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionProgressEvent

ToolExecutionProgressEvent.ToolExecutionProgressData - Record Class in com.github.copilot.sdk.events

ToolExecutionStartData(String, String, Object, String, String, String) - Constructor for record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Creates an instance of a ToolExecutionStartData record class.

ToolExecutionStartEvent - Class in com.github.copilot.sdk.events

Event: tool.execution_start

ToolExecutionStartEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionStartEvent

ToolExecutionStartEvent.ToolExecutionStartData - Record Class in com.github.copilot.sdk.events

ToolHandler - Interface in com.github.copilot.sdk.json

Functional interface for handling tool invocations from the AI assistant.

ToolInvocation - Class in com.github.copilot.sdk.json

Represents a tool invocation request from the AI assistant.

ToolInvocation() - Constructor for class com.github.copilot.sdk.json.ToolInvocation

toolName() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns the value of the toolName record component.

toolName() - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Returns the value of the toolName record component.

ToolRequest(String, String, Object) - Constructor for record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Creates an instance of a ToolRequest record class.

toolRequests() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns a defensive copy of the tool requests list.

ToolResultObject - Record Class in com.github.copilot.sdk.json

Result object returned from a tool execution.

ToolResultObject(String, String, List<ToolBinaryResult>, String, String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.json.ToolResultObject

Creates an instance of a ToolResultObject record class.

tools() - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Returns a defensive copy of the tools array.

toolTelemetry() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns a defensive copy of the tool telemetry map.

toolTelemetry() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns the value of the toolTelemetry record component.

ToolUserRequestedData(String, String, Object) - Constructor for record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Creates an instance of a ToolUserRequestedData record class.

ToolUserRequestedEvent - Class in com.github.copilot.sdk.events

Event: tool.user_requested

ToolUserRequestedEvent() - Constructor for class com.github.copilot.sdk.events.ToolUserRequestedEvent

ToolUserRequestedEvent.ToolUserRequestedData - Record Class in com.github.copilot.sdk.events

toString() - Method in record class com.github.copilot.sdk.events.AbortEvent.AbortData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.HookEndEvent.HookEndData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.HookStartEvent.HookStartData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.PendingMessagesModifiedEvent.PendingMessagesModifiedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.CompactionTokensUsed

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionCompactionStartEvent.SessionCompactionStartData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionIdleEvent.SessionIdleData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.CodeChanges

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SkillInvokedEvent.SkillInvokedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection.Position

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment.Selection

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.Attachment

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.PingResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SendMessageResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.ToolDefinition

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.ToolResultObject

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Returns a string representation of this record class.

toString() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Returns a string representation of this record class.

totalApiDurationMs() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the totalApiDurationMs record component.

totalPremiumRequests() - Method in record class com.github.copilot.sdk.events.SessionShutdownEvent.SessionShutdownData

Returns the value of the totalPremiumRequests record component.

totalResponseSizeBytes() - Method in record class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData

Returns the value of the totalResponseSizeBytes record component.

transformedContent() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Returns the value of the transformedContent record component.

turnId() - Method in record class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData

Returns the value of the turnId record component.

turnId() - Method in record class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData

Returns the value of the turnId record component.

type() - Method in record class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData

Returns the value of the type record component.

type() - Method in record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment

Returns the value of the type record component.

type() - Method in record class com.github.copilot.sdk.json.Attachment

Returns the value of the type record component.

type() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult

Returns the value of the type record component.

TYPE - Static variable in class com.github.copilot.sdk.events.ToolExecutionProgressEvent

U

UPDATED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes

Event fired when a session is updated.

upToEventId() - Method in record class com.github.copilot.sdk.events.SessionSnapshotRewindEvent.SessionSnapshotRewindData

Returns the value of the upToEventId record component.

UserInputHandler - Interface in com.github.copilot.sdk.json

Handler for user input requests from the agent.

UserInputInvocation - Class in com.github.copilot.sdk.json

Context for a user input request invocation.

UserInputInvocation() - Constructor for class com.github.copilot.sdk.json.UserInputInvocation

UserInputRequest - Class in com.github.copilot.sdk.json

Request for user input from the agent.

UserInputRequest() - Constructor for class com.github.copilot.sdk.json.UserInputRequest

UserInputResponse - Class in com.github.copilot.sdk.json

Response to a user input request.

UserInputResponse() - Constructor for class com.github.copilot.sdk.json.UserInputResponse

UserMessageData(String, String, List<UserMessageEvent.UserMessageData.Attachment>, String) - Constructor for record class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData

Creates an instance of a UserMessageData record class.

UserMessageEvent - Class in com.github.copilot.sdk.events

Event: user.message

UserMessageEvent() - Constructor for class com.github.copilot.sdk.events.UserMessageEvent

UserMessageEvent.UserMessageData - Record Class in com.github.copilot.sdk.events

UserMessageEvent.UserMessageData.Attachment - Record Class in com.github.copilot.sdk.events

UserMessageEvent.UserMessageData.Attachment.Selection - Record Class in com.github.copilot.sdk.events

UserMessageEvent.UserMessageData.Attachment.Selection.Position - Record Class in com.github.copilot.sdk.events

UserPromptSubmittedHandler - Interface in com.github.copilot.sdk.json

Handler for user-prompt-submitted hooks.

UserPromptSubmittedHookInput - Record Class in com.github.copilot.sdk.json

Input for a user-prompt-submitted hook.

UserPromptSubmittedHookInput(long, String, String) - Constructor for record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput

Creates an instance of a UserPromptSubmittedHookInput record class.

UserPromptSubmittedHookOutput - Record Class in com.github.copilot.sdk.json

Output for a user-prompt-submitted hook.

UserPromptSubmittedHookOutput(String, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput

Creates an instance of a UserPromptSubmittedHookOutput record class.

V

valueOf(String) - Static method in enum class com.github.copilot.sdk.ConnectionState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.github.copilot.sdk.EventErrorPolicy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.github.copilot.sdk.events.SessionShutdownEvent.ShutdownType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.github.copilot.sdk.SystemMessageMode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.github.copilot.sdk.ConnectionState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.github.copilot.sdk.EventErrorPolicy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.github.copilot.sdk.events.SessionShutdownEvent.ShutdownType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.github.copilot.sdk.SystemMessageMode

Returns an array containing the constants of this enum class, in the order they are declared.

version() - Method in record class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData

Returns the value of the version record component.

W

withModifiedArgs(String, JsonNode) - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput

Creates an output with modified tool arguments.

workspacePath() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse

Returns the value of the workspacePath record component.

workspacePath() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse

Returns the value of the workspacePath record component.

workspacePath() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse

Returns the value of the workspacePath record component.

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values