Skip to content

useSessionSettings

View as Markdown
function useSessionSettings(): object;

Defined in: react/src/hooks.ts:169

Settings the composer edits. With an open session: its settings and capabilities; an update applies from the next run (pendingForNextRun while a run started before the change is still active). In a draft (no session yet): the draft settings, validated against the draft runtime and applied by commitDraft right after the session is created.

object

Name Type Defined in
capabilities? object react/src/hooks.ts:171
capabilities.approval object protocol/dist/index.d.ts:174
capabilities.approval.once boolean protocol/dist/index.d.ts:175
capabilities.approval.session boolean protocol/dist/index.d.ts:176
capabilities.approval.types ("mcp" | "file" | "shell" | "network" | "other")[] protocol/dist/index.d.ts:177
capabilities.attachments object protocol/dist/index.d.ts:215
capabilities.attachments.files boolean protocol/dist/index.d.ts:217
capabilities.attachments.images boolean protocol/dist/index.d.ts:216
capabilities.attachments.maxBytes number protocol/dist/index.d.ts:218
capabilities.attachments.maxImageBytes? number protocol/dist/index.d.ts:219
capabilities.diffEvents boolean protocol/dist/index.d.ts:186
capabilities.efforts ("low" | "medium" | "high" | "xhigh" | "max")[] protocol/dist/index.d.ts:201
capabilities.mcp boolean protocol/dist/index.d.ts:187
capabilities.models object[] protocol/dist/index.d.ts:195
capabilities.modelsAuthoritative? boolean protocol/dist/index.d.ts:200
capabilities.nativeResume boolean protocol/dist/index.d.ts:185
capabilities.permissionModes ("default" | "acceptEdits" | "plan" | "auto" | "bypassPermissions")[] protocol/dist/index.d.ts:208
capabilities.siteTools boolean protocol/dist/index.d.ts:194
capabilities.skills "unknown" | "supported" | "partial" | "prompt" protocol/dist/index.d.ts:188
capabilities.streaming boolean protocol/dist/index.d.ts:173
pendingForNextRun boolean react/src/hooks.ts:173
settings object react/src/hooks.ts:170
settings.effort? "low" | "medium" | "high" | "xhigh" | "max" protocol/dist/index.d.ts:142
settings.model? string protocol/dist/index.d.ts:141
settings.permissionMode "default" | "acceptEdits" | "plan" | "auto" | "bypassPermissions" protocol/dist/index.d.ts:149
update() (patch) => Promise<boolean> react/src/hooks.ts:172