Skip to content

Commit 02b1a68

Browse files
Deploy documentation: snapshot
1 parent f336f8a commit 02b1a68

356 files changed

Lines changed: 823 additions & 675 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

snapshot/apidocs/allclasses-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>All Classes and Interfaces (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/allpackages-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>All Packages (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/ConnectionState.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>ConnectionState (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/CopilotClient.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>CopilotClient (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/CopilotSession.html

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>CopilotSession (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -287,6 +287,8 @@ <h3>setEventErrorHandler</h3>
287287
<dt>Parameters:</dt>
288288
<dd><code>handler</code> - the error handler, or <code>null</code> to use only the default logging
289289
behavior</dd>
290+
<dt>Throws:</dt>
291+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
290292
<dt>Since:</dt>
291293
<dd>1.0.8</dd>
292294
<dt>See Also:</dt>
@@ -332,6 +334,8 @@ <h3>setEventErrorPolicy</h3>
332334
<dt>Parameters:</dt>
333335
<dd><code>policy</code> - the error policy (default is
334336
<a href="EventErrorPolicy.html#PROPAGATE_AND_LOG_ERRORS"><code>EventErrorPolicy.PROPAGATE_AND_LOG_ERRORS</code></a>)</dd>
337+
<dt>Throws:</dt>
338+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
335339
<dt>Since:</dt>
336340
<dd>1.0.8</dd>
337341
<dt>See Also:</dt>
@@ -357,6 +361,8 @@ <h3>send</h3>
357361
<dd><code>prompt</code> - the message text to send</dd>
358362
<dt>Returns:</dt>
359363
<dd>a future that resolves with the message ID assigned by the server</dd>
364+
<dt>Throws:</dt>
365+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
360366
<dt>See Also:</dt>
361367
<dd>
362368
<ul class="see-list">
@@ -380,6 +386,8 @@ <h3>sendAndWait</h3>
380386
<dt>Returns:</dt>
381387
<dd>a future that resolves with the final assistant message event, or
382388
<code>null</code> if no assistant message was received</dd>
389+
<dt>Throws:</dt>
390+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
383391
<dt>See Also:</dt>
384392
<dd>
385393
<ul class="see-list">
@@ -402,6 +410,8 @@ <h3>send</h3>
402410
<dd><code>options</code> - the message options containing the prompt and attachments</dd>
403411
<dt>Returns:</dt>
404412
<dd>a future that resolves with the message ID assigned by the server</dd>
413+
<dt>Throws:</dt>
414+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
405415
<dt>See Also:</dt>
406416
<dd>
407417
<ul class="see-list">
@@ -431,6 +441,8 @@ <h3>sendAndWait</h3>
431441
<code>null</code> if no assistant message was received. The future
432442
completes exceptionally with a TimeoutException if the timeout
433443
expires.</dd>
444+
<dt>Throws:</dt>
445+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
434446
<dt>See Also:</dt>
435447
<dd>
436448
<ul class="see-list">
@@ -453,6 +465,8 @@ <h3>sendAndWait</h3>
453465
<dt>Returns:</dt>
454466
<dd>a future that resolves with the final assistant message event, or
455467
<code>null</code> if no assistant message was received</dd>
468+
<dt>Throws:</dt>
469+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
456470
<dt>See Also:</dt>
457471
<dd>
458472
<ul class="see-list-long">
@@ -492,6 +506,8 @@ <h3>on</h3>
492506
<dd><code>handler</code> - a callback to be invoked when a session event occurs</dd>
493507
<dt>Returns:</dt>
494508
<dd>a Closeable that, when closed, unsubscribes the handler</dd>
509+
<dt>Throws:</dt>
510+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
495511
<dt>See Also:</dt>
496512
<dd>
497513
<ul class="see-list-long">
@@ -548,6 +564,8 @@ <h3>on</h3>
548564
<dd><code>handler</code> - a callback invoked when events of this type occur</dd>
549565
<dt>Returns:</dt>
550566
<dd>a Closeable that unsubscribes the handler when closed</dd>
567+
<dt>Throws:</dt>
568+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
551569
<dt>See Also:</dt>
552570
<dd>
553571
<ul class="see-list">
@@ -569,6 +587,8 @@ <h3>getMessages</h3>
569587
<dl class="notes">
570588
<dt>Returns:</dt>
571589
<dd>a future that resolves with a list of all session events</dd>
590+
<dt>Throws:</dt>
591+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
572592
<dt>See Also:</dt>
573593
<dd>
574594
<ul class="see-list">
@@ -589,6 +609,8 @@ <h3>abort</h3>
589609
<dl class="notes">
590610
<dt>Returns:</dt>
591611
<dd>a future that completes when the abort is acknowledged</dd>
612+
<dt>Throws:</dt>
613+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if this session has been terminated</dd>
592614
</dl>
593615
</section>
594616
</li>
@@ -600,7 +622,7 @@ <h3>close</h3>
600622
<p>
601623
This destroys the session on the server, clears all event handlers, and
602624
releases tool and permission handlers. After calling this method, the session
603-
cannot be used again.</div>
625+
cannot be used again. Subsequent calls to this method have no effect.</div>
604626
<dl class="notes">
605627
<dt>Specified by:</dt>
606628
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>

snapshot/apidocs/com/github/copilot/sdk/EventErrorHandler.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>EventErrorHandler (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/EventErrorPolicy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>EventErrorPolicy (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/SdkProtocolVersion.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>SdkProtocolVersion (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/SystemMessageMode.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>SystemMessageMode (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

snapshot/apidocs/com/github/copilot/sdk/class-use/ConnectionState.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sat Feb 07 02:06:03 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Sat Feb 07 17:21:07 UTC 2026 -->
55
<title>Uses of Enum Class com.github.copilot.sdk.ConnectionState (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

0 commit comments

Comments
 (0)