copilot-sdk-java/snapshot/jacoco/com.github.copilot.rpc/ElicitationContext.java.html at gh-pages · github/copilot-sdk-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>ElicitationContext.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">GitHub Copilot SDK :: Java</a> &gt; <a href="index.source.html" class="el_package">com.github.copilot.rpc</a> &gt; <span class="el_source">ElicitationContext.java</span></div><h1>ElicitationContext.java</h1><pre class="source lang-java linenums">/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

package com.github.copilot.rpc;

/**
 * Context for an elicitation request received from the server or MCP tools.
 *
 * @since 1.0.0
 */
<span class="fc" id="L12">public class ElicitationContext {</span>

    private String sessionId;
    private String message;
    private ElicitationSchema requestedSchema;
    private String mode;
    private String elicitationSource;
    private String url;

    /**
     * Gets the session ID that triggered the elicitation request. @return the
     * session ID
     */
    public String getSessionId() {
<span class="fc" id="L26">        return sessionId;</span>
    }

    /** Sets the session ID. @param sessionId the session ID @return this */
    public ElicitationContext setSessionId(String sessionId) {
<span class="fc" id="L31">        this.sessionId = sessionId;</span>
<span class="fc" id="L32">        return this;</span>
    }

    /**
     * Gets the message describing what information is needed from the user.
     *
     * @return the message
     */
    public String getMessage() {
<span class="fc" id="L41">        return message;</span>
    }

    /** Sets the message. @param message the message @return this */
    public ElicitationContext setMessage(String message) {
<span class="fc" id="L46">        this.message = message;</span>
<span class="fc" id="L47">        return this;</span>
    }

    /**
     * Gets the JSON Schema describing the form fields to present (form mode only).
     *
     * @return the schema, or {@code null}
     */
    public ElicitationSchema getRequestedSchema() {
<span class="fc" id="L56">        return requestedSchema;</span>
    }

    /** Sets the schema. @param requestedSchema the schema @return this */
    public ElicitationContext setRequestedSchema(ElicitationSchema requestedSchema) {
<span class="fc" id="L61">        this.requestedSchema = requestedSchema;</span>
<span class="fc" id="L62">        return this;</span>
    }

    /**
     * Gets the elicitation mode: {@code &quot;form&quot;} for structured input, {@code &quot;url&quot;}
     * for browser redirect.
     *
     * @return the mode, or {@code null} (defaults to {@code &quot;form&quot;})
     */
    public String getMode() {
<span class="fc" id="L72">        return mode;</span>
    }

    /** Sets the mode. @param mode the mode @return this */
    public ElicitationContext setMode(String mode) {
<span class="fc" id="L77">        this.mode = mode;</span>
<span class="fc" id="L78">        return this;</span>
    }

    /**
     * Gets the source that initiated the request (e.g., MCP server name).
     *
     * @return the elicitation source, or {@code null}
     */
    public String getElicitationSource() {
<span class="fc" id="L87">        return elicitationSource;</span>
    }

    /**
     * Sets the elicitation source. @param elicitationSource the source @return this
     */
    public ElicitationContext setElicitationSource(String elicitationSource) {
<span class="fc" id="L94">        this.elicitationSource = elicitationSource;</span>
<span class="fc" id="L95">        return this;</span>
    }

    /**
     * Gets the URL to open in the user's browser (url mode only).
     *
     * @return the URL, or {@code null}
     */
    public String getUrl() {
<span class="fc" id="L104">        return url;</span>
    }

    /** Sets the URL. @param url the URL @return this */
    public ElicitationContext setUrl(String url) {
<span class="fc" id="L109">        this.url = url;</span>
<span class="fc" id="L110">        return this;</span>
    }
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.14.202510111229</span></div></body></html>