# useSession

<!-- https://uncage.vercel.app/docs/api/react/functions/usesession/ -->

```ts
function useSession(): object;
```

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

## Returns

`object`

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `connection` | [`ConnectionState`](https://uncage.vercel.app/docs/api/react/type-aliases/connectionstate.md) | react/src/hooks.ts:96 |
| `replayIncomplete` | `boolean` | react/src/hooks.ts:96 |
| `session?` | `object` | react/src/hooks.ts:96 |
| `session.activeRunId?` | `string` | protocol/dist/index.d.ts:373 |
| `session.capabilities` | `object` | protocol/dist/index.d.ts:306 |
| `session.capabilities.approval` | `object` | protocol/dist/index.d.ts:308 |
| `session.capabilities.approval.once` | `boolean` | protocol/dist/index.d.ts:309 |
| `session.capabilities.approval.session` | `boolean` | protocol/dist/index.d.ts:310 |
| `session.capabilities.approval.types` | (`"mcp"` \| `"file"` \| `"shell"` \| `"network"` \| `"other"`)[] | protocol/dist/index.d.ts:311 |
| `session.capabilities.attachments` | `object` | protocol/dist/index.d.ts:349 |
| `session.capabilities.attachments.files` | `boolean` | protocol/dist/index.d.ts:351 |
| `session.capabilities.attachments.images` | `boolean` | protocol/dist/index.d.ts:350 |
| `session.capabilities.attachments.maxBytes` | `number` | protocol/dist/index.d.ts:352 |
| `session.capabilities.attachments.maxImageBytes?` | `number` | protocol/dist/index.d.ts:353 |
| `session.capabilities.diffEvents` | `boolean` | protocol/dist/index.d.ts:320 |
| `session.capabilities.efforts` | (`"low"` \| `"medium"` \| `"high"` \| `"xhigh"` \| `"max"`)[] | protocol/dist/index.d.ts:335 |
| `session.capabilities.mcp` | `boolean` | protocol/dist/index.d.ts:321 |
| `session.capabilities.models` | `object`[] | protocol/dist/index.d.ts:329 |
| `session.capabilities.modelsAuthoritative?` | `boolean` | protocol/dist/index.d.ts:334 |
| `session.capabilities.nativeResume` | `boolean` | protocol/dist/index.d.ts:319 |
| `session.capabilities.permissionModes` | (`"default"` \| `"acceptEdits"` \| `"plan"` \| `"auto"` \| `"bypassPermissions"`)[] | protocol/dist/index.d.ts:342 |
| `session.capabilities.siteTools` | `boolean` | protocol/dist/index.d.ts:328 |
| `session.capabilities.skills` | `"unknown"` \| `"supported"` \| `"partial"` \| `"prompt"` | protocol/dist/index.d.ts:322 |
| `session.capabilities.streaming` | `boolean` | protocol/dist/index.d.ts:307 |
| `session.createdAt` | `string` | protocol/dist/index.d.ts:305 |
| `session.id` | `string` | protocol/dist/index.d.ts:294 |
| `session.machineId?` | `string` | protocol/dist/index.d.ts:374 |
| `session.readOnly` | `boolean` | protocol/dist/index.d.ts:304 |
| `session.runtimeId` | `string` | protocol/dist/index.d.ts:295 |
| `session.settings` | `object` | protocol/dist/index.d.ts:356 |
| `session.settings.effort?` | `"low"` \| `"medium"` \| `"high"` \| `"xhigh"` \| `"max"` | protocol/dist/index.d.ts:358 |
| `session.settings.model?` | `string` | protocol/dist/index.d.ts:357 |
| `session.settings.permissionMode` | `"default"` \| `"acceptEdits"` \| `"plan"` \| `"auto"` \| `"bypassPermissions"` | protocol/dist/index.d.ts:365 |
| `session.status` | `"ready"` \| `"busy"` \| `"unavailable"` \| `"closed"` | protocol/dist/index.d.ts:298 |
| `session.title` | `string` | protocol/dist/index.d.ts:297 |
| `session.workspace` | `string` | protocol/dist/index.d.ts:296 |
