Class ServerUserSettingsApi

java.lang.Object

com.github.copilot.generated.rpc.ServerUserSettingsApi

@Generated("copilot-sdk-codegen")
public final class ServerUserSettingsApi
extends Object

API methods for the user.settings namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<UserSettingsGetResult>	get()	Lists every known user setting from settings.json, each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value.
CompletableFuture<Void>	set(UserSettingsSetParams params)	Writes one or more user settings to settings.json, replacing each provided top-level key.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

@CopilotExperimental
public CompletableFuture<UserSettingsGetResult> get()

Lists every known user setting from settings.json, each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time.

Since:

1.0.0

set

@CopilotExperimental
public CompletableFuture<Void> set(UserSettingsSetParams params)

Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed.

Since:

1.0.0