Index

A C D E F G H I J L M O P R S T U V 
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() - Constructor for class com.github.copilot.sdk.events.AbortEvent.AbortData
 
AbortEvent - Class in com.github.copilot.sdk.events
Event: abort
AbortEvent() - Constructor for class com.github.copilot.sdk.events.AbortEvent
 
AbortEvent.AbortData - 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
 
APPEND - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode
Append the custom content to the default system message.
AssistantIntentData() - Constructor for class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData
 
AssistantIntentEvent - Class in com.github.copilot.sdk.events
Event: assistant.intent
AssistantIntentEvent() - Constructor for class com.github.copilot.sdk.events.AssistantIntentEvent
 
AssistantIntentEvent.AssistantIntentData - Class in com.github.copilot.sdk.events
 
AssistantMessageData() - Constructor for class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
 
AssistantMessageDeltaData() - Constructor for class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
AssistantMessageDeltaEvent - Class in com.github.copilot.sdk.events
Event: assistant.message_delta
AssistantMessageDeltaEvent() - Constructor for class com.github.copilot.sdk.events.AssistantMessageDeltaEvent
 
AssistantMessageDeltaEvent.AssistantMessageDeltaData - 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 - Class in com.github.copilot.sdk.events
Contains the assistant message content and metadata.
AssistantMessageEvent.AssistantMessageData.ToolRequest - Class in com.github.copilot.sdk.events
Represents a request from the assistant to invoke a tool.
AssistantReasoningData() - Constructor for class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData
 
AssistantReasoningDeltaData() - Constructor for class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData
 
AssistantReasoningDeltaEvent - Class in com.github.copilot.sdk.events
Event: assistant.reasoning_delta
AssistantReasoningDeltaEvent() - Constructor for class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent
 
AssistantReasoningDeltaEvent.AssistantReasoningDeltaData - 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 - Class in com.github.copilot.sdk.events
 
AssistantTurnEndData() - Constructor for class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData
 
AssistantTurnEndEvent - Class in com.github.copilot.sdk.events
Event: assistant.turn_end
AssistantTurnEndEvent() - Constructor for class com.github.copilot.sdk.events.AssistantTurnEndEvent
 
AssistantTurnEndEvent.AssistantTurnEndData - Class in com.github.copilot.sdk.events
 
AssistantTurnStartData() - Constructor for class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData
 
AssistantTurnStartEvent - Class in com.github.copilot.sdk.events
Event: assistant.turn_start
AssistantTurnStartEvent() - Constructor for class com.github.copilot.sdk.events.AssistantTurnStartEvent
 
AssistantTurnStartEvent.AssistantTurnStartData - Class in com.github.copilot.sdk.events
 
AssistantUsageData() - Constructor for class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
AssistantUsageEvent - Class in com.github.copilot.sdk.events
Event: assistant.usage
AssistantUsageEvent() - Constructor for class com.github.copilot.sdk.events.AssistantUsageEvent
 
AssistantUsageEvent.AssistantUsageData - Class in com.github.copilot.sdk.events
 
Attachment - Class in com.github.copilot.sdk.json
Represents a file attachment to include with a message.
Attachment() - Constructor for class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
Attachment() - Constructor for class com.github.copilot.sdk.json.Attachment
 
AzureOptions - Class in com.github.copilot.sdk.json
Azure OpenAI-specific configuration options.
AzureOptions() - Constructor for class com.github.copilot.sdk.json.AzureOptions
 

C

close() - Method in class com.github.copilot.sdk.CopilotClient
 
close() - Method in class com.github.copilot.sdk.CopilotSession
Disposes the session and releases all associated resources.
com.github.copilot.sdk - package com.github.copilot.sdk
 
com.github.copilot.sdk.events - package com.github.copilot.sdk.events
 
com.github.copilot.sdk.json - package com.github.copilot.sdk.json
 
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.
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.
create(String, String, Map<String, Object>, ToolHandler) - Static method in class com.github.copilot.sdk.json.ToolDefinition
Creates a tool definition with a JSON schema for parameters.
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 - Class in com.github.copilot.sdk.json
 
CreateSessionResponse() - Constructor for class com.github.copilot.sdk.json.CreateSessionResponse
 
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
 

D

deleteSession(String) - Method in class com.github.copilot.sdk.CopilotClient
Deletes a session by ID.
DeleteSessionResponse - Class in com.github.copilot.sdk.json
Internal response object from deleting a session.
DeleteSessionResponse() - Constructor for class com.github.copilot.sdk.json.DeleteSessionResponse
 
DISCONNECTED - Enum constant in enum class com.github.copilot.sdk.ConnectionState
The client is not connected to the server.

E

Error() - Constructor for class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error
 
ERROR - Enum constant in enum class com.github.copilot.sdk.ConnectionState
The client encountered an error during connection or operation.

F

forceStop() - Method in class com.github.copilot.sdk.CopilotClient
Forces an immediate stop of the client without graceful cleanup.

G

get() - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion
Gets the SDK protocol version.
getAgentDescription() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
getAgentDisplayName() - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
getAgentDisplayName() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
getAgentName() - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData
 
getAgentName() - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
getAgentName() - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
getAgentName() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
getApiCallId() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
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.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Gets the arguments to pass to the tool.
getArguments() - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
getArguments() - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
getArguments() - Method in class com.github.copilot.sdk.json.ToolInvocation
Gets the arguments passed to the tool.
getAttachments() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
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.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
 
getBinaryResultsForLlm() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the binary results to be sent to the LLM.
getBranch() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
getBufferExhaustionThreshold() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
Gets the buffer exhaustion threshold.
getCacheReadTokens() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getCacheWriteTokens() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getCapabilities() - Method in class com.github.copilot.sdk.json.ModelInfo
 
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.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error
 
getCode() - Method in class com.github.copilot.sdk.json.JsonRpcError
Gets the error code.
getContent() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Gets the text content of the assistant's message.
getContent() - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData
 
getContent() - Method in class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
getContent() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result
 
getContent() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
getContent() - Method in class com.github.copilot.sdk.json.SystemMessageConfig
Gets the system message content.
getContext() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
getCopilotVersion() - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
getCost() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getCurrentTokens() - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
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.
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.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.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.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.
getData() - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Gets the base64-encoded binary data.
getDeltaContent() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
getDeltaContent() - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData
 
getDescription() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
Gets the agent description.
getDescription() - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Gets the description of the binary content.
getDescription() - Method in class com.github.copilot.sdk.json.ToolDef
Gets the tool description.
getDescription() - Method in class com.github.copilot.sdk.json.ToolDefinition
Gets the tool description.
getDisplayName() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
getDisplayName() - Method in class com.github.copilot.sdk.json.Attachment
Gets the display name.
getDisplayName() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
Gets the human-readable display name.
getDuration() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
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.events.HookEndEvent.HookEndData
 
getError() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getError() - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
getError() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
getError() - Method in class com.github.copilot.sdk.json.DeleteSessionResponse
Gets the error message if the deletion failed.
getError() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
Gets the error if the RPC call failed.
getError() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the error message.
getErrorType() - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
getEventCount() - Method in class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData
 
getEvents() - Method in class com.github.copilot.sdk.json.GetMessagesResponse
 
getExcludedTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
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.
getHandler() - Method in class com.github.copilot.sdk.json.ToolDefinition
Gets the tool handler.
getHandoffTime() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
getHookInvocationId() - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
getHookInvocationId() - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
getHookType() - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
getHookType() - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
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.SessionConfig
Gets the infinite sessions configuration.
getInfoType() - Method in class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData
 
getInitiator() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getInput() - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
getInputTokens() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getIntent() - Method in class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData
 
getIsUserRequested() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
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 - Class in com.github.copilot.sdk.json
 
GetLastSessionIdResponse() - Constructor for class com.github.copilot.sdk.json.GetLastSessionIdResponse
 
getLimits() - Method in class com.github.copilot.sdk.json.ModelCapabilities
 
getLogger() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
Gets the custom logger for the client.
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.events.HookEndEvent.HookEndData.HookError
 
getMessage() - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
getMessage() - Method in class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData
 
getMessage() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error
 
getMessage() - Method in class com.github.copilot.sdk.json.JsonRpcError
Gets the error message.
getMessage() - Method in class com.github.copilot.sdk.json.PingResponse
Gets the echo message from the server.
getMessageId() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
getMessageId() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Gets the unique message identifier.
getMessageId() - Method in class com.github.copilot.sdk.json.SendMessageResponse
Gets the message ID assigned by the server.
getMessages() - Method in class com.github.copilot.sdk.CopilotSession
Gets the complete list of messages and events in the session.
getMessagesLength() - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
getMessagesRemoved() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getMessagesRemovedDuringTruncation() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
GetMessagesResponse - Class in com.github.copilot.sdk.json
 
GetMessagesResponse() - Constructor for class com.github.copilot.sdk.json.GetMessagesResponse
 
getMetadata() - Method in class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
getMethod() - Method in class com.github.copilot.sdk.json.JsonRpcRequest
Gets the method name.
getMimeType() - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Gets the MIME type of the binary data.
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.events.AssistantUsageEvent.AssistantUsageData
 
getModel() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
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.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Gets the name of the tool to invoke.
getName() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
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
 
getName() - Method in class com.github.copilot.sdk.json.ToolDef
Gets the tool name.
getName() - Method in class com.github.copilot.sdk.json.ToolDefinition
Gets the tool name.
getNewModel() - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData
 
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.
getOutput() - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
getOutputTokens() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getOwner() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
getParameters() - Method in class com.github.copilot.sdk.json.ToolDef
Gets the JSON Schema for tool parameters.
getParameters() - Method in class com.github.copilot.sdk.json.ToolDefinition
Gets the parameter schema.
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.
getParentToolCallId() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
getParentToolCallId() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Gets the parent tool call ID if this message is in response to a tool.
getParentToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
getParentToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
getPartialOutput() - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData
 
getPath() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
getPath() - Method in class com.github.copilot.sdk.json.Attachment
Gets the file path.
getPerformedBy() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
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.
getPostCompactionTokens() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getPostTruncationMessagesLength() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getPostTruncationTokensInMessages() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getPreCompactionMessagesLength() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getPreCompactionTokens() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getPreTruncationMessagesLength() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getPreTruncationTokensInMessages() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getPreviousModel() - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData
 
getProducer() - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
getProgressMessage() - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData
 
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
 
getProtocolVersion() - Method in class com.github.copilot.sdk.json.PingResponse
Gets the SDK protocol version supported by the server.
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.
getProviderCallId() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getQuotaSnapshots() - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
getReason() - Method in class com.github.copilot.sdk.events.AbortEvent.AbortData
 
getReasoningId() - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData
 
getReasoningId() - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData
 
getRemoteSessionId() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
getRepository() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
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.
getResult() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
getResult() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
Gets the result of the RPC call.
getResultType() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the result type.
getResumeTime() - Method in class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData
 
getRules() - Method in class com.github.copilot.sdk.json.PermissionRequestResult
Gets the approval rules.
getSelectedModel() - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
getSessionId() - Method in class com.github.copilot.sdk.CopilotSession
Gets the unique identifier for this session.
getSessionId() - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
getSessionId() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
Gets the session ID.
getSessionId() - Method in class com.github.copilot.sdk.json.CreateSessionResponse
 
getSessionId() - Method in class com.github.copilot.sdk.json.GetLastSessionIdResponse
 
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.ResumeSessionResponse
 
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.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.
getSessionLog() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the session log entry.
getSessions() - Method in class com.github.copilot.sdk.json.ListSessionsResponse
Gets the list of sessions.
getSource() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
getSourceType() - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
getStack() - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError
 
getStack() - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
getStartTime() - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
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.events.SessionHandoffEvent.SessionHandoffData
 
getSummary() - Method in class com.github.copilot.sdk.json.SessionMetadata
Gets a brief summary of the session's conversation.
getSummaryContent() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getSupportedMediaTypes() - Method in class com.github.copilot.sdk.json.ModelVisionLimits
 
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.SessionConfig
Gets the system message configuration.
getTerms() - Method in class com.github.copilot.sdk.json.ModelPolicy
 
getTextResultForLlm() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the text result to be sent to the LLM.
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.PingResponse
Gets the server timestamp.
getTokenLimit() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getTokenLimit() - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
getTokensRemoved() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
getTokensRemovedDuringTruncation() - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Gets the unique tool call identifier.
getToolCallId() - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
getToolCallId() - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
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.events.ToolExecutionStartEvent.ToolExecutionStartData
 
getToolName() - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
getToolName() - Method in class com.github.copilot.sdk.json.ToolInvocation
Gets the name of the tool being invoked.
getToolRequests() - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Gets the list of tool requests made by the assistant.
getTools() - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
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.
getToolTelemetry() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
getToolTelemetry() - Method in class com.github.copilot.sdk.json.ToolResultObject
Gets the tool telemetry data.
getTotalResponseSizeBytes() - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
getTransformedContent() - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
getTurnId() - Method in class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData
 
getTurnId() - Method in class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData
 
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.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.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.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.SystemMessageEvent.SystemMessageData
 
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.events.UserMessageEvent.UserMessageData.Attachment
 
getType() - Method in class com.github.copilot.sdk.json.Attachment
Gets the attachment type.
getType() - Method in class com.github.copilot.sdk.json.ProviderConfig
Gets the provider type.
getType() - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Gets the type of binary content.
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.events.SessionStartEvent.SessionStartData
 
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.
getWorkspacePath() - Method in class com.github.copilot.sdk.CopilotSession
Gets the path to the session workspace directory when infinite sessions are enabled.
getWorkspacePath() - Method in class com.github.copilot.sdk.json.CreateSessionResponse
Gets the workspace path when infinite sessions are enabled.
getWorkspacePath() - Method in class com.github.copilot.sdk.json.ResumeSessionResponse
Gets the workspace path 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.
HookEndData() - Constructor for class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
HookEndEvent - Class in com.github.copilot.sdk.events
Event: hook.end
HookEndEvent() - Constructor for class com.github.copilot.sdk.events.HookEndEvent
 
HookEndEvent.HookEndData - Class in com.github.copilot.sdk.events
 
HookEndEvent.HookEndData.HookError - Class in com.github.copilot.sdk.events
 
HookError() - Constructor for class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError
 
HookStartData() - Constructor for class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
HookStartEvent - Class in com.github.copilot.sdk.events
Event: hook.start
HookStartEvent() - Constructor for class com.github.copilot.sdk.events.HookStartEvent
 
HookStartEvent.HookStartData - Class in com.github.copilot.sdk.events
 

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
 
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.
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.
isSuccess() - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
isSuccess() - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
isSuccess() - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
isSuccess() - Method in class com.github.copilot.sdk.json.DeleteSessionResponse
Returns whether the deletion was successful.
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
 

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
 
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.
ListSessionsResponse - Class in com.github.copilot.sdk.json
Internal response object from listing sessions.
ListSessionsResponse() - Constructor for class com.github.copilot.sdk.json.ListSessionsResponse
 

M

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
 
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
 
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
 

O

on(Consumer<AbstractSessionEvent>) - Method in class com.github.copilot.sdk.CopilotSession
Registers a callback for session events.

P

parse(JsonNode) - Static method in class com.github.copilot.sdk.events.SessionEventParser
Parses a JsonNode into the appropriate SessionEvent subclass.
parse(String) - Static method in class com.github.copilot.sdk.events.SessionEventParser
Parses a JSON string into the appropriate SessionEvent subclass.
PendingMessagesModifiedData() - Constructor for class com.github.copilot.sdk.events.PendingMessagesModifiedEvent.PendingMessagesModifiedData
 
PendingMessagesModifiedEvent - Class in com.github.copilot.sdk.events
Event: pending_messages.modified
PendingMessagesModifiedEvent() - Constructor for class com.github.copilot.sdk.events.PendingMessagesModifiedEvent
 
PendingMessagesModifiedEvent.PendingMessagesModifiedData - Class in com.github.copilot.sdk.events
 
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 - Class in com.github.copilot.sdk.json
Response from a ping request to the Copilot CLI server.
PingResponse() - Constructor for class com.github.copilot.sdk.json.PingResponse
 
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
 

R

REPLACE - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode
Replace the default system message entirely with the custom content.
Repository() - Constructor for class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
Result() - Constructor for class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result
 
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 - Class in com.github.copilot.sdk.json
 
ResumeSessionResponse() - Constructor for class com.github.copilot.sdk.json.ResumeSessionResponse
 

S

SdkProtocolVersion - Enum Class in com.github.copilot.sdk
Provides the SDK protocol version.
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 - Class in com.github.copilot.sdk.json
Internal response object from sending a message.
SendMessageResponse() - Constructor for class com.github.copilot.sdk.json.SendMessageResponse
 
SessionCompactionCompleteData() - Constructor for class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
SessionCompactionCompleteEvent - Class in com.github.copilot.sdk.events
Event: session.compaction_complete
SessionCompactionCompleteEvent() - Constructor for class com.github.copilot.sdk.events.SessionCompactionCompleteEvent
 
SessionCompactionCompleteEvent.SessionCompactionCompleteData - Class in com.github.copilot.sdk.events
 
SessionCompactionStartData() - Constructor for class com.github.copilot.sdk.events.SessionCompactionStartEvent.SessionCompactionStartData
 
SessionCompactionStartEvent - Class in com.github.copilot.sdk.events
Event: session.compaction_start
SessionCompactionStartEvent() - Constructor for class com.github.copilot.sdk.events.SessionCompactionStartEvent
 
SessionCompactionStartEvent.SessionCompactionStartData - 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
 
SessionErrorData() - Constructor for class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
SessionErrorEvent - Class in com.github.copilot.sdk.events
Event: session.error
SessionErrorEvent() - Constructor for class com.github.copilot.sdk.events.SessionErrorEvent
 
SessionErrorEvent.SessionErrorData - 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() - Constructor for class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
SessionHandoffEvent - Class in com.github.copilot.sdk.events
Event: session.handoff
SessionHandoffEvent() - Constructor for class com.github.copilot.sdk.events.SessionHandoffEvent
 
SessionHandoffEvent.SessionHandoffData - Class in com.github.copilot.sdk.events
 
SessionHandoffEvent.SessionHandoffData.Repository - Class in com.github.copilot.sdk.events
 
SessionIdleData() - Constructor for class com.github.copilot.sdk.events.SessionIdleEvent.SessionIdleData
 
SessionIdleEvent - Class in com.github.copilot.sdk.events
Event: session.idle
SessionIdleEvent() - Constructor for class com.github.copilot.sdk.events.SessionIdleEvent
 
SessionIdleEvent.SessionIdleData - Class in com.github.copilot.sdk.events
 
SessionInfoData() - Constructor for class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData
 
SessionInfoEvent - Class in com.github.copilot.sdk.events
Event: session.info
SessionInfoEvent() - Constructor for class com.github.copilot.sdk.events.SessionInfoEvent
 
SessionInfoEvent.SessionInfoData - Class in com.github.copilot.sdk.events
 
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() - Constructor for class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData
 
SessionModelChangeEvent - Class in com.github.copilot.sdk.events
Event: session.model_change
SessionModelChangeEvent() - Constructor for class com.github.copilot.sdk.events.SessionModelChangeEvent
 
SessionModelChangeEvent.SessionModelChangeData - Class in com.github.copilot.sdk.events
 
SessionResumeData() - Constructor for class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData
 
SessionResumeEvent - Class in com.github.copilot.sdk.events
Event: session.resume
SessionResumeEvent() - Constructor for class com.github.copilot.sdk.events.SessionResumeEvent
 
SessionResumeEvent.SessionResumeData - Class in com.github.copilot.sdk.events
 
SessionStartData() - Constructor for class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
SessionStartEvent - Class in com.github.copilot.sdk.events
Event: session.start
SessionStartEvent() - Constructor for class com.github.copilot.sdk.events.SessionStartEvent
 
SessionStartEvent.SessionStartData - Class in com.github.copilot.sdk.events
 
SessionTruncationData() - Constructor for class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
SessionTruncationEvent - Class in com.github.copilot.sdk.events
Event: session.truncation
SessionTruncationEvent() - Constructor for class com.github.copilot.sdk.events.SessionTruncationEvent
 
SessionTruncationEvent.SessionTruncationData - Class in com.github.copilot.sdk.events
 
SessionUsageInfoData() - Constructor for class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
SessionUsageInfoEvent - Class in com.github.copilot.sdk.events
Event: session.usage_info
SessionUsageInfoEvent() - Constructor for class com.github.copilot.sdk.events.SessionUsageInfoEvent
 
SessionUsageInfoEvent.SessionUsageInfoData - Class in com.github.copilot.sdk.events
 
setAgentDescription(String) - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
setAgentDisplayName(String) - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
setAgentDisplayName(String) - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
setAgentName(String) - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData
 
setAgentName(String) - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
setAgentName(String) - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
setAgentName(String) - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
setApiCallId(String) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
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(Object) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Sets the tool arguments.
setArguments(Object) - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
setArguments(Object) - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
setArguments(Object) - Method in class com.github.copilot.sdk.json.ToolInvocation
Sets the tool arguments.
setAttachments(List<UserMessageEvent.UserMessageData.Attachment>) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
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.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
 
setBinaryResultsForLlm(List<ToolBinaryResult>) - Method in class com.github.copilot.sdk.json.ToolResultObject
Sets binary results (images, files) to be sent to the LLM.
setBranch(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
setBufferExhaustionThreshold(Double) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
Sets the context utilization threshold at which the session blocks until compaction completes.
setCacheReadTokens(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setCacheWriteTokens(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setCapabilities(ModelCapabilities) - Method in class com.github.copilot.sdk.json.ModelInfo
 
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.
setCode(String) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error
 
setContent(String) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Sets the message content.
setContent(String) - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData
 
setContent(String) - Method in class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
setContent(String) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result
 
setContent(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
setContent(String) - Method in class com.github.copilot.sdk.json.SystemMessageConfig
Sets the system message content.
setContext(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
setCopilotVersion(String) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
setCost(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setCurrentTokens(double) - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
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.
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(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(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(Object) - Method in class com.github.copilot.sdk.json.JsonRpcError
Sets the additional error data.
setData(String) - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Sets the base64-encoded binary data.
setDeltaContent(String) - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
setDeltaContent(String) - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData
 
setDescription(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
Sets a description of the agent's capabilities.
setDescription(String) - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Sets a description of the binary content.
setDescription(String) - Method in class com.github.copilot.sdk.json.ToolDef
Sets the tool description.
setDescription(String) - Method in class com.github.copilot.sdk.json.ToolDefinition
Sets the tool description.
setDisplayName(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
setDisplayName(String) - Method in class com.github.copilot.sdk.json.Attachment
Sets a human-readable display name for the attachment.
setDisplayName(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
Sets the human-readable display name.
setDuration(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
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(HookEndEvent.HookEndData.HookError) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
setError(ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setError(JsonRpcError) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
Sets the error for a failed RPC call.
setError(String) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setError(String) - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
setError(String) - Method in class com.github.copilot.sdk.json.DeleteSessionResponse
Sets the error message.
setError(String) - Method in class com.github.copilot.sdk.json.ToolResultObject
Sets an error message for failed tool execution.
setErrorType(String) - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
setEventCount(double) - Method in class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData
 
setEvents(List<JsonNode>) - Method in class com.github.copilot.sdk.json.GetMessagesResponse
 
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.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.
setHandler(ToolHandler) - Method in class com.github.copilot.sdk.json.ToolDefinition
Sets the tool handler.
setHandoffTime(OffsetDateTime) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
setHookInvocationId(String) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
setHookInvocationId(String) - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
setHookType(String) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
setHookType(String) - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
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.SessionConfig
Sets the infinite session configuration for persistent workspaces and automatic compaction.
setInfoType(String) - Method in class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData
 
setInitiator(String) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setInput(Object) - Method in class com.github.copilot.sdk.events.HookStartEvent.HookStartData
 
setInputTokens(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setIntent(String) - Method in class com.github.copilot.sdk.events.AssistantIntentEvent.AssistantIntentData
 
setIsUserRequested(Boolean) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
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
 
setLogger(Logger) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
Sets a custom logger for the client.
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.events.HookEndEvent.HookEndData.HookError
 
setMessage(String) - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
setMessage(String) - Method in class com.github.copilot.sdk.events.SessionInfoEvent.SessionInfoData
 
setMessage(String) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error
 
setMessage(String) - Method in class com.github.copilot.sdk.json.JsonRpcError
Sets the error message.
setMessage(String) - Method in class com.github.copilot.sdk.json.PingResponse
Sets the message.
setMessageId(String) - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
setMessageId(String) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Sets the message identifier.
setMessageId(String) - Method in class com.github.copilot.sdk.json.SendMessageResponse
Sets the message ID.
setMessagesLength(double) - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
setMessagesRemoved(Double) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setMessagesRemovedDuringTruncation(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setMetadata(Map<String, Object>) - Method in class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
setMethod(String) - Method in class com.github.copilot.sdk.json.JsonRpcRequest
Sets the method name.
setMimeType(String) - Method in class com.github.copilot.sdk.json.ToolBinaryResult
Sets the MIME type of the binary data.
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.events.AssistantUsageEvent.AssistantUsageData
 
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.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.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Sets the tool name.
setName(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
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
 
setName(String) - Method in class com.github.copilot.sdk.json.ToolDef
Sets the tool name.
setName(String) - Method in class com.github.copilot.sdk.json.ToolDefinition
Sets the tool name.
setNewModel(String) - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData
 
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.
setOutput(Object) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
setOutputTokens(Double) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setOwner(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData.Repository
 
setParameters(Object) - Method in class com.github.copilot.sdk.json.ToolDef
Sets the JSON Schema for tool parameters.
setParameters(Object) - Method in class com.github.copilot.sdk.json.ToolDefinition
Sets the parameter schema.
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.
setParentToolCallId(String) - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
setParentToolCallId(String) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Sets the parent tool call ID.
setParentToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setParentToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
setPartialOutput(String) - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData
 
setPath(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
setPath(String) - Method in class com.github.copilot.sdk.json.Attachment
Sets the file path.
setPerformedBy(String) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
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.
setPostCompactionTokens(Double) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setPostTruncationMessagesLength(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setPostTruncationTokensInMessages(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setPreCompactionMessagesLength(Double) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setPreCompactionTokens(Double) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setPreTruncationMessagesLength(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setPreTruncationTokensInMessages(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setPreviousModel(String) - Method in class com.github.copilot.sdk.events.SessionModelChangeEvent.SessionModelChangeData
 
setProducer(String) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
setProgressMessage(String) - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData
 
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
 
setProtocolVersion(Integer) - Method in class com.github.copilot.sdk.json.PingResponse
Sets the protocol version.
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.
setProviderCallId(String) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setQuotaSnapshots(Map<String, Object>) - Method in class com.github.copilot.sdk.events.AssistantUsageEvent.AssistantUsageData
 
setReason(String) - Method in class com.github.copilot.sdk.events.AbortEvent.AbortData
 
setReasoningId(String) - Method in class com.github.copilot.sdk.events.AssistantReasoningDeltaEvent.AssistantReasoningDeltaData
 
setReasoningId(String) - Method in class com.github.copilot.sdk.events.AssistantReasoningEvent.AssistantReasoningData
 
setRemote(boolean) - Method in class com.github.copilot.sdk.json.SessionMetadata
Sets whether this session is stored remotely.
setRemoteSessionId(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
setRepository(SessionHandoffEvent.SessionHandoffData.Repository) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
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.
setResult(ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setResult(Object) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
Sets the result of the RPC call.
setResultType(String) - Method in class com.github.copilot.sdk.json.ToolResultObject
Sets the result type.
setResumeTime(OffsetDateTime) - Method in class com.github.copilot.sdk.events.SessionResumeEvent.SessionResumeData
 
setRules(List<Object>) - Method in class com.github.copilot.sdk.json.PermissionRequestResult
Sets approval rules for future similar requests.
setSelectedModel(String) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
setSessionId(String) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
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.CreateSessionResponse
 
setSessionId(String) - Method in class com.github.copilot.sdk.json.GetLastSessionIdResponse
 
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.ResumeSessionResponse
 
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.SessionMetadata
Sets the session identifier.
setSessionId(String) - Method in class com.github.copilot.sdk.json.ToolInvocation
Sets the session ID.
setSessionLog(String) - Method in class com.github.copilot.sdk.json.ToolResultObject
Sets a log entry to be recorded in the session.
setSessions(List<SessionMetadata>) - Method in class com.github.copilot.sdk.json.ListSessionsResponse
Sets the list of sessions.
setSource(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
setSourceType(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
setStack(String) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData.HookError
 
setStack(String) - Method in class com.github.copilot.sdk.events.SessionErrorEvent.SessionErrorData
 
setStartTime(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
Sets the session start time.
setStartTime(OffsetDateTime) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
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.
setSuccess(boolean) - Method in class com.github.copilot.sdk.events.HookEndEvent.HookEndData
 
setSuccess(boolean) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setSuccess(boolean) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setSuccess(boolean) - Method in class com.github.copilot.sdk.json.DeleteSessionResponse
Sets whether the deletion was successful.
setSummary(String) - Method in class com.github.copilot.sdk.events.SessionHandoffEvent.SessionHandoffData
 
setSummary(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
Sets the session summary.
setSummaryContent(String) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setSupportedMediaTypes(List<String>) - Method in class com.github.copilot.sdk.json.ModelVisionLimits
 
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.SessionConfig
Sets the system message configuration.
setTerms(String) - Method in class com.github.copilot.sdk.json.ModelPolicy
 
setTextResultForLlm(String) - Method in class com.github.copilot.sdk.json.ToolResultObject
Sets the text result to be sent to the LLM.
setTimestamp(long) - Method in class com.github.copilot.sdk.json.PingResponse
Sets the timestamp.
setTimestamp(OffsetDateTime) - Method in class com.github.copilot.sdk.events.AbstractSessionEvent
Sets the event timestamp.
setTokenLimit(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setTokenLimit(double) - Method in class com.github.copilot.sdk.events.SessionUsageInfoEvent.SessionUsageInfoData
 
setTokensRemoved(Double) - Method in class com.github.copilot.sdk.events.SessionCompactionCompleteEvent.SessionCompactionCompleteData
 
setTokensRemovedDuringTruncation(double) - Method in class com.github.copilot.sdk.events.SessionTruncationEvent.SessionTruncationData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
Sets the tool call identifier.
setToolCallId(String) - Method in class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
setToolCallId(String) - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
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.events.ToolExecutionStartEvent.ToolExecutionStartData
 
setToolName(String) - Method in class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
setToolName(String) - Method in class com.github.copilot.sdk.json.ToolInvocation
Sets the tool name.
setToolRequests(List<AssistantMessageEvent.AssistantMessageData.ToolRequest>) - Method in class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData
Sets the tool requests.
setTools(String[]) - Method in class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
setTools(List<ToolDef>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
Sets the tools.
setTools(List<ToolDef>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
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.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.
setToolTelemetry(Map<String, Object>) - Method in class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
setToolTelemetry(Map<String, Object>) - Method in class com.github.copilot.sdk.json.ToolResultObject
 
setTotalResponseSizeBytes(Double) - Method in class com.github.copilot.sdk.events.AssistantMessageDeltaEvent.AssistantMessageDeltaData
 
setTransformedContent(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
setTurnId(String) - Method in class com.github.copilot.sdk.events.AssistantTurnEndEvent.AssistantTurnEndData
 
setTurnId(String) - Method in class com.github.copilot.sdk.events.AssistantTurnStartEvent.AssistantTurnStartData
 
setType(String) - Method in class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
setType(String) - Method in class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData.Attachment
 
setType(String) - Method in class com.github.copilot.sdk.json.Attachment
Sets the attachment type.
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.ToolBinaryResult
Sets the type of binary content.
setUseStdio(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
Sets whether to use stdio transport instead of TCP.
setVersion(double) - Method in class com.github.copilot.sdk.events.SessionStartEvent.SessionStartData
 
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
 
setWireApi(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
Sets the wire API format for custom providers.
setWorkspacePath(String) - Method in class com.github.copilot.sdk.json.CreateSessionResponse
 
setWorkspacePath(String) - Method in class com.github.copilot.sdk.json.ResumeSessionResponse
 
start() - Method in class com.github.copilot.sdk.CopilotClient
Starts the Copilot client and connects to the server.
stop() - Method in class com.github.copilot.sdk.CopilotClient
Stops the client and closes all sessions.
SubagentCompletedData() - Constructor for class com.github.copilot.sdk.events.SubagentCompletedEvent.SubagentCompletedData
 
SubagentCompletedEvent - Class in com.github.copilot.sdk.events
Event: subagent.completed
SubagentCompletedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentCompletedEvent
 
SubagentCompletedEvent.SubagentCompletedData - Class in com.github.copilot.sdk.events
 
SubagentFailedData() - Constructor for class com.github.copilot.sdk.events.SubagentFailedEvent.SubagentFailedData
 
SubagentFailedEvent - Class in com.github.copilot.sdk.events
Event: subagent.failed
SubagentFailedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentFailedEvent
 
SubagentFailedEvent.SubagentFailedData - Class in com.github.copilot.sdk.events
 
SubagentSelectedData() - Constructor for class com.github.copilot.sdk.events.SubagentSelectedEvent.SubagentSelectedData
 
SubagentSelectedEvent - Class in com.github.copilot.sdk.events
Event: subagent.selected
SubagentSelectedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentSelectedEvent
 
SubagentSelectedEvent.SubagentSelectedData - Class in com.github.copilot.sdk.events
 
SubagentStartedData() - Constructor for class com.github.copilot.sdk.events.SubagentStartedEvent.SubagentStartedData
 
SubagentStartedEvent - Class in com.github.copilot.sdk.events
Event: subagent.started
SubagentStartedEvent() - Constructor for class com.github.copilot.sdk.events.SubagentStartedEvent
 
SubagentStartedEvent.SubagentStartedData - Class in com.github.copilot.sdk.events
 
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() - Constructor for class com.github.copilot.sdk.events.SystemMessageEvent.SystemMessageData
 
SystemMessageEvent - Class in com.github.copilot.sdk.events
Event: system.message
SystemMessageEvent() - Constructor for class com.github.copilot.sdk.events.SystemMessageEvent
 
SystemMessageEvent.SystemMessageData - 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

ToolBinaryResult - Class in com.github.copilot.sdk.json
Binary result from a tool execution.
ToolBinaryResult() - Constructor for class com.github.copilot.sdk.json.ToolBinaryResult
 
ToolDef - Class in com.github.copilot.sdk.json
Low-level tool definition for JSON-RPC communication.
ToolDef() - Constructor for class com.github.copilot.sdk.json.ToolDef
Creates an empty tool definition.
ToolDef(String, String, Object) - Constructor for class com.github.copilot.sdk.json.ToolDef
Creates a tool definition with all fields.
ToolDefinition - Class in com.github.copilot.sdk.json
Defines a tool that can be invoked by the AI assistant.
ToolDefinition() - Constructor for class com.github.copilot.sdk.json.ToolDefinition
Creates an empty tool definition.
ToolDefinition(String, String, Object, ToolHandler) - Constructor for class com.github.copilot.sdk.json.ToolDefinition
Creates a tool definition with all properties.
ToolExecutionCompleteData() - Constructor for class com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
 
ToolExecutionCompleteEvent - Class in com.github.copilot.sdk.events
Event: tool.execution_complete
ToolExecutionCompleteEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionCompleteEvent
 
ToolExecutionCompleteEvent.ToolExecutionCompleteData - Class in com.github.copilot.sdk.events
 
ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error - Class in com.github.copilot.sdk.events
 
ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result - Class in com.github.copilot.sdk.events
 
ToolExecutionPartialResultData() - Constructor for class com.github.copilot.sdk.events.ToolExecutionPartialResultEvent.ToolExecutionPartialResultData
 
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 - Class in com.github.copilot.sdk.events
 
ToolExecutionProgressData() - Constructor for class com.github.copilot.sdk.events.ToolExecutionProgressEvent.ToolExecutionProgressData
 
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 - Class in com.github.copilot.sdk.events
 
ToolExecutionStartData() - Constructor for class com.github.copilot.sdk.events.ToolExecutionStartEvent.ToolExecutionStartData
 
ToolExecutionStartEvent - Class in com.github.copilot.sdk.events
Event: tool.execution_start
ToolExecutionStartEvent() - Constructor for class com.github.copilot.sdk.events.ToolExecutionStartEvent
 
ToolExecutionStartEvent.ToolExecutionStartData - 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
 
ToolRequest() - Constructor for class com.github.copilot.sdk.events.AssistantMessageEvent.AssistantMessageData.ToolRequest
 
ToolResultObject - Class in com.github.copilot.sdk.json
Result object returned from a tool execution.
ToolResultObject() - Constructor for class com.github.copilot.sdk.json.ToolResultObject
 
ToolUserRequestedData() - Constructor for class com.github.copilot.sdk.events.ToolUserRequestedEvent.ToolUserRequestedData
 
ToolUserRequestedEvent - Class in com.github.copilot.sdk.events
Event: tool.user_requested
ToolUserRequestedEvent() - Constructor for class com.github.copilot.sdk.events.ToolUserRequestedEvent
 
ToolUserRequestedEvent.ToolUserRequestedData - Class in com.github.copilot.sdk.events
 
TYPE - Static variable in class com.github.copilot.sdk.events.ToolExecutionProgressEvent
 

U

UserMessageData() - Constructor for class com.github.copilot.sdk.events.UserMessageEvent.UserMessageData
 
UserMessageEvent - Class in com.github.copilot.sdk.events
Event: user.message
UserMessageEvent() - Constructor for class com.github.copilot.sdk.events.UserMessageEvent
 
UserMessageEvent.UserMessageData - Class in com.github.copilot.sdk.events
 
UserMessageEvent.UserMessageData.Attachment - Class in com.github.copilot.sdk.events
 

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.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.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.
A C D E F G H I J L M O P R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values