Package com.github.copilot.sdk.json

Record Class SetForegroundSessionResponse

java.lang.Object
java.lang.Record
com.github.copilot.sdk.json.SetForegroundSessionResponse
public record SetForegroundSessionResponse(boolean success, String error) extends Record
Response from session.setForeground RPC call.

This is only available when connecting to a server running in TUI+server mode (--ui-server).

Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SetForegroundSessionResponse(boolean success, String error)
    Creates an instance of a SetForegroundSessionResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    error()
    Returns the value of the error record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    success()
    Returns the value of the success record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SetForegroundSessionResponse

      public SetForegroundSessionResponse(boolean success, String error)
      Creates an instance of a SetForegroundSessionResponse record class.
      Parameters:
      success - the value for the success record component
      error - the value for the error record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • error

      public String error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component