Class
CopilotClient
Client for the GitHub Copilot CLI protocol.
Inheritance
- Object
- CopilotClient
Methods
public async Task<CopilotSession> CreateSessionAsync(CopilotSessionOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<CopilotSession>Creates a new Copilot session.
Parameters
- options IntelligenceX.Copilot.CopilotSessionOptions = null
- Session options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public async Task DeleteSessionAsync(String sessionId, CancellationToken cancellationToken = null) #Returns:
TaskDeletes a Copilot session.
Parameters
- sessionId System.String
- Session id.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public virtual async ValueTask DisposeAsync() #Returns:
ValueTaskDisposes the client asynchronously.
public async Task<CopilotAuthStatus> GetAuthStatusAsync(CancellationToken cancellationToken = null) #Returns:
Task<CopilotAuthStatus>Retrieves Copilot authentication status.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public async Task<CopilotStatus> GetStatusAsync(CancellationToken cancellationToken = null) #Returns:
Task<CopilotStatus>Retrieves Copilot CLI status information.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public async Task<HealthCheckResult> HealthCheckAsync(Nullable<TimeSpan> timeout = null, CancellationToken cancellationToken = null) #Returns:
Task<HealthCheckResult>Executes a health check call.
Parameters
- timeout System.Nullable{System.TimeSpan} = null
- Optional timeout.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public async Task<IReadOnlyList<CopilotModelInfo>> ListModelsAsync(CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<CopilotModelInfo>>Lists available Copilot models.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
public static async Task<CopilotClient> StartAsync(CopilotClientOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<CopilotClient>Starts the Copilot client.
Parameters
- options IntelligenceX.Copilot.CopilotClientOptions = null
- Optional client options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Events
public event EventHandler<String> StandardErrorReceived #Raised when standard error output is received.
public event EventHandler<String> StandardOutputReceived #Raised when standard output is received.
public event EventHandler<String> ProtocolMessageReceived #Raised when a protocol message is received.
public event EventHandler<String> ProtocolMessageSent #Raised when a protocol message is sent.
public event EventHandler<RpcCallStartedEventArgs> RpcCallStarted #Raised when an RPC call starts.
public event EventHandler<RpcCallCompletedEventArgs> RpcCallCompleted #Raised when an RPC call completes.