Class SessionPermissionsPathsApi

java.lang.Object

com.github.copilot.generated.rpc.SessionPermissionsPathsApi

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

API methods for the permissions.paths namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionPermissionsPathsAddResult>	add(SessionPermissionsPathsAddParams params)	Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it.
CompletableFuture<SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult>	isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params)	Reports whether a path falls within any of the session's allowed directories.
CompletableFuture<SessionPermissionsPathsIsPathWithinWorkspaceResult>	isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params)	Reports whether a path falls within the session's workspace (primary) directory.
CompletableFuture<SessionPermissionsPathsListResult>	list()	Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
CompletableFuture<SessionPermissionsPathsUpdatePrimaryResult>	updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params)	Updates the session's primary working directory used by the permission policy.

Methods inherited from class Object

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

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionPermissionsPathsListResult> list()

Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.

Since:

1.0.0

add

@CopilotExperimental
public CompletableFuture<SessionPermissionsPathsAddResult> add(SessionPermissionsPathsAddParams params)

Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

updatePrimary

@CopilotExperimental
public CompletableFuture<SessionPermissionsPathsUpdatePrimaryResult> updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params)

Updates the session's primary working directory used by the permission policy.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

isPathWithinAllowedDirectories

@CopilotExperimental
public CompletableFuture<SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult> isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params)

Reports whether a path falls within any of the session's allowed directories.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

isPathWithinWorkspace

@CopilotExperimental
public CompletableFuture<SessionPermissionsPathsIsPathWithinWorkspaceResult> isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params)

Reports whether a path falls within the session's workspace (primary) directory.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0