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()	Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default.
CompletableFuture<Void>	reload()	Invokes user.settings.reload.
CompletableFuture<UserSettingsSetResult>	set(UserSettingsSetParams params)	Partial user settings to write to settings.json.

Methods inherited from class Object

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

Method Details

reload

@CopilotExperimental
public CompletableFuture<Void> reload()

Invokes user.settings.reload.

Since:

1.0.0

get

@CopilotExperimental
public CompletableFuture<UserSettingsGetResult> get()

Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides.

Since:

1.0.0

set

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

Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.

Since:

1.0.0