test-wuying-agentbay-sdk/docs/api/common-features/basics/context-manager.md

TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment

# Class: ContextManager

## 🗂️ Related Tutorial

- [Data Persistence Guide](../../../../../docs/guides/common-features/basics/data-persistence.md) - Learn about context management and data persistence

## Table of contents


### Methods

- [info](#info)
- [infoWithParams](#infowithparams)
- [sync](#sync)

## Methods

### info

▸ **info**(): `Promise`\<``ContextInfoResult``\>

Gets information about context synchronization status for the current session.

#### Returns

`Promise`\<``ContextInfoResult``\>

Promise resolving to ContextInfoResult containing context status data and request ID

**`Throws`**

Error if the API call fails

**`Example`**

```typescript
const agentBay = new AgentBay({ apiKey: 'your_api_key' });
const result = await agentBay.create();
if (result.success) {
  const info = await result.session.context.info();
  console.log(`Context count: ${info.contextStatusData.length}`);
  await result.session.delete();
}
```

___

### infoWithParams

▸ **infoWithParams**(`contextId?`, `path?`, `taskType?`): `Promise`\<``ContextInfoResult``\>

Gets information about context synchronization status with optional filter parameters.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `contextId?` | `string` | Optional context ID to filter results |
| `path?` | `string` | Optional path to filter results |
| `taskType?` | `string` | Optional task type to filter results (e.g., "upload", "download") |

#### Returns

`Promise`\<``ContextInfoResult``\>

Promise resolving to ContextInfoResult containing filtered context status data and request ID

**`Throws`**

Error if the API call fails

**`Example`**

```typescript
const agentBay = new AgentBay({ apiKey: 'your_api_key' });
const result = await agentBay.create();
if (result.success) {
  const info = await result.session.context.infoWithParams('SdkCtx-xxx', '/mnt/persistent');
  console.log(`Context status: ${info.contextStatusData[0]?.status}`);
  await result.session.delete();
}
```

___

### sync

▸ **sync**(`contextId?`, `path?`, `mode?`, `callback?`, `maxRetries?`, `retryInterval?`): `Promise`\<``ContextSyncResult``\>

Synchronizes a context with the session. Supports both async and callback modes.

#### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `contextId?` | `string` | `undefined` | Optional context ID to synchronize |
| `path?` | `string` | `undefined` | Optional path where the context should be mounted |
| `mode?` | `string` | `undefined` | Optional synchronization mode (e.g., "upload", "download") |
| `callback?` | ``SyncCallback`` | `undefined` | Optional callback function. If provided, runs in background and calls callback when complete |
| `maxRetries` | `number` | `150` | Maximum number of retries for polling completion status (default: 150) |
| `retryInterval` | `number` | `1500` | Milliseconds to wait between retries (default: 1500) |

#### Returns

`Promise`\<``ContextSyncResult``\>

Promise resolving to ContextSyncResult with success status and request ID

**`Throws`**

Error if the API call fails

**`Example`**

```typescript
const agentBay = new AgentBay({ apiKey: 'your_api_key' });
const result = await agentBay.create();
if (result.success) {
  const ctxResult = await agentBay.context.get('my-context', true);
  const syncResult = await result.session.context.sync(ctxResult.context!.id, '/mnt/persistent', 'upload');
  console.log(`Sync: ${syncResult.success}`);
  await result.session.delete();
}
```

## Related Resources

- [Context API Reference](context.md)
- [Session API Reference](session.md)