wuying-agentbay-sdk 0.11.0 → 0.13.0

package/docs/api/common-features/basics/session-params.md

@@ -0,0 +1,382 @@
+# Class: CreateSessionParams
+
+CreateSessionParams provides a way to configure the parameters for creating a new session
+in the AgentBay cloud environment.
+
+## Implements
+
+- ``CreateSessionParamsConfig``
+
+## Table of contents
+
+
+### Properties
+
+- [browserContext](#browsercontext)
+- [enableBrowserReplay](#enablebrowserreplay)
+- [extraConfigs](#extraconfigs)
+- [framework](#framework)
+- [imageId](#imageid)
+- [policyId](#policyid)
+
+### Methods
+
+- [addContextSync](#addcontextsync)
+- [addContextSyncConfig](#addcontextsyncconfig)
+- [fromJSON](#fromjson)
+- [toJSON](#tojson)
+- [withBrowserContext](#withbrowsercontext)
+- [withContextSync](#withcontextsync)
+- [withEnableBrowserReplay](#withenablebrowserreplay)
+- [withEnableRecord](#withenablerecord)
+- [withExtraConfigs](#withextraconfigs)
+- [withFramework](#withframework)
+- [withImageId](#withimageid)
+- [withIsVpc](#withisvpc)
+- [withLabels](#withlabels)
+- [withPolicyId](#withpolicyid)
+
+## Properties
+
+```typescript
+contextSync: [`ContextSync`](context-sync.md)[]
+isVpc: `boolean`
+labels: `Record`<`string`, `string`>
+```
+
+
+### browserContext
+
+• `Optional` **browserContext**: ``BrowserContext``
+
+Optional configuration for browser data synchronization.
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`browserContext`
+
+___
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`contextSync`
+
+___
+
+### enableBrowserReplay
+
+• `Optional` **enableBrowserReplay**: `boolean`
+
+Whether to enable browser recording for the session. Defaults to undefined (use default behavior, enabled by default).
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`enableBrowserReplay`
+
+___
+
+### extraConfigs
+
+• `Optional` **extraConfigs**: ``ExtraConfigs``
+
+Extra configuration settings for different session types (e.g., mobile)
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`extraConfigs`
+
+___
+
+### framework
+
+• `Optional` **framework**: `string`
+
+Framework name for SDK statistics tracking
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`framework`
+
+___
+
+### imageId
+
+• `Optional` **imageId**: `string`
+
+Image ID to use for the session.
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`imageId`
+
+___
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`isVpc`
+
+___
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`labels`
+
+___
+
+### policyId
+
+• `Optional` **policyId**: `string`
+
+Policy id to apply when creating the session.
+
+#### Implementation of
+
+`CreateSessionParamsConfig`.`policyId`
+
+## Methods
+
+### addContextSync
+
+▸ **addContextSync**(`contextId`, `path`, `policy?`): [`CreateSessionParams`](session-params.md)
+
+AddContextSync adds a context sync configuration to the session parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `contextId` | `string` |
+| `path` | `string` |
+| `policy?` | ``SyncPolicy`` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### addContextSyncConfig
+
+▸ **addContextSyncConfig**(`contextSync`): [`CreateSessionParams`](session-params.md)
+
+AddContextSyncConfig adds a pre-configured context sync to the session parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `contextSync` | [`ContextSync`](context-sync.md) |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### fromJSON
+
+▸ **fromJSON**(`config`): [`CreateSessionParams`](session-params.md)
+
+Create from plain object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config` | ``CreateSessionParamsConfig`` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): ``CreateSessionParamsConfig``
+
+Convert to plain object for JSON serialization
+
+#### Returns
+
+``CreateSessionParamsConfig``
+
+___
+
+### withBrowserContext
+
+▸ **withBrowserContext**(`browserContext`): [`CreateSessionParams`](session-params.md)
+
+WithBrowserContext sets the browser context for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `browserContext` | ``BrowserContext`` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withContextSync
+
+▸ **withContextSync**(`contextSyncs`): [`CreateSessionParams`](session-params.md)
+
+WithContextSync sets the context sync configurations for the session parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `contextSyncs` | [`ContextSync`](context-sync.md)[] |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withEnableBrowserReplay
+
+▸ **withEnableBrowserReplay**(`enableBrowserReplay`): [`CreateSessionParams`](session-params.md)
+
+WithenableBrowserReplay sets the browser recording flag for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `enableBrowserReplay` | `boolean` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withEnableRecord
+
+▸ **withEnableRecord**(`enableRecord`): [`CreateSessionParams`](session-params.md)
+
+Alias for withEnableBrowserReplay for backward compatibility.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `enableRecord` | `boolean` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withExtraConfigs
+
+▸ **withExtraConfigs**(`extraConfigs`): [`CreateSessionParams`](session-params.md)
+
+WithExtraConfigs sets the extra configurations for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `extraConfigs` | ``ExtraConfigs`` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withFramework
+
+▸ **withFramework**(`framework`): [`CreateSessionParams`](session-params.md)
+
+WithFramework sets the framework name for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `framework` | `string` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withImageId
+
+▸ **withImageId**(`imageId`): [`CreateSessionParams`](session-params.md)
+
+WithImageId sets the image ID for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `imageId` | `string` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withIsVpc
+
+▸ **withIsVpc**(`isVpc`): [`CreateSessionParams`](session-params.md)
+
+WithIsVpc sets the VPC flag for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `isVpc` | `boolean` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withLabels
+
+▸ **withLabels**(`labels`): [`CreateSessionParams`](session-params.md)
+
+WithLabels sets the labels for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `labels` | `Record`\<`string`, `string`\> |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)
+
+___
+
+### withPolicyId
+
+▸ **withPolicyId**(`policyId`): [`CreateSessionParams`](session-params.md)
+
+WithPolicyId sets the policy id for the session parameters and returns the updated parameters.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `policyId` | `string` |
+
+#### Returns
+
+[`CreateSessionParams`](session-params.md)

package/docs/api/common-features/basics/session.md

@@ -21,6 +21,8 @@ Represents a session in the AgentBay cloud environment.
 - [getLinkAsync](#getlinkasync)
 - [info](#info)
 - [listMcpTools](#listmcptools)
+- [pauseAsync](#pauseasync)
+- [resumeAsync](#resumeasync)
 - [setLabels](#setlabels)
 
 ## Properties
@@ -34,14 +36,12 @@ computer: [`Computer`](../../computer-use/computer.md)
 context: [`ContextManager`](context-manager.md)
 enableBrowserReplay: `boolean` = `false`
 fileSystem: [`FileSystem`](filesystem.md)
-fileTransferContextId: ``null`` | `string` = `null`
 httpPort: `string` = `""`
 isVpc: `boolean` = `false`
 mcpTools: `McpTool`[] = `[]`
 mobile: [`Mobile`](../../mobile-use/mobile.md)
 networkInterfaceIp: `string` = `""`
 oss: [`Oss`](../advanced/oss.md)
-recordContextId: ``null`` | `string` = `null`
 resourceUrl: `string` = `""`
 sessionId: `string`
 token: `string` = `""`
@@ -368,6 +368,134 @@ if (result.success) {
 
 ___
 
+### pauseAsync
+
+▸ **pauseAsync**(`timeout?`, `pollInterval?`): `Promise`\<`SessionPauseResult`\>
+
+Asynchronously pause this session, putting it into a dormant state.
+
+This method calls the PauseSessionAsync API to initiate the pause operation and then polls
+the GetSession API to check the session status until it becomes PAUSED or until timeout is reached.
+During the paused state, resource usage and costs are reduced while session state is preserved.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `timeout` | `number` | `600` | Timeout in seconds to wait for the session to pause. Defaults to 600 seconds. |
+| `pollInterval` | `number` | `2.0` | Interval in seconds between status polls. Defaults to 2.0 seconds. |
+
+#### Returns
+
+`Promise`\<`SessionPauseResult`\>
+
+Promise resolving to SessionPauseResult containing:
+         - success: Whether the pause operation succeeded
+         - requestId: Unique identifier for this API request
+         - status: Final session status (should be "PAUSED" if successful)
+         - errorMessage: Error description if pause failed
+
+**`Throws`**
+
+Error if the API call fails or network issues occur.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const result = await agentBay.create();
+if (result.success) {
+  const pauseResult = await result.session.pauseAsync();
+  if (pauseResult.success) {
+    console.log('Session paused successfully');
+  }
+}
+```
+
+**`Remarks`**
+
+**Behavior:**
+- Initiates pause operation through PauseSessionAsync API
+- Polls session status until PAUSED state or timeout
+- Session state transitions: RUNNING -> PAUSING -> PAUSED
+- All session state is preserved during pause
+
+**Important Notes:**
+- Paused sessions cannot perform operations (deletion, task execution, etc.)
+- Use [resumeAsync](#resumeasync) to restore the session to RUNNING state
+- During pause, both resource usage and costs are lower
+- If timeout is exceeded, returns with success=false
+
+**`See`**
+
+[resumeAsync](#resumeasync)
+
+___
+
+### resumeAsync
+
+▸ **resumeAsync**(`timeout?`, `pollInterval?`): `Promise`\<`SessionResumeResult`\>
+
+Asynchronously resume this session from a paused state.
+
+This method calls the ResumeSessionAsync API to initiate the resume operation and then polls
+the GetSession API to check the session status until it becomes RUNNING or until timeout is reached.
+After resuming, the session restores full functionality and can perform all operations normally.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `timeout` | `number` | `600` | Timeout in seconds to wait for the session to resume. Defaults to 600 seconds. |
+| `pollInterval` | `number` | `2.0` | Interval in seconds between status polls. Defaults to 2.0 seconds. |
+
+#### Returns
+
+`Promise`\<`SessionResumeResult`\>
+
+Promise resolving to SessionResumeResult containing:
+         - success: Whether the resume operation succeeded
+         - requestId: Unique identifier for this API request
+         - status: Final session status (should be "RUNNING" if successful)
+         - errorMessage: Error description if resume failed
+
+**`Throws`**
+
+Error if the API call fails or network issues occur.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const result = await agentBay.get('paused_session_id');
+if (result.success) {
+  const resumeResult = await result.session.resumeAsync();
+  if (resumeResult.success) {
+    console.log('Session resumed successfully');
+  }
+}
+```
+
+**`Remarks`**
+
+**Behavior:**
+- Initiates resume operation through ResumeSessionAsync API
+- Polls session status until RUNNING state or timeout
+- Session state transitions: PAUSED -> RESUMING -> RUNNING
+- All previous session state is restored during resume
+
+**Important Notes:**
+- Only sessions in PAUSED state can be resumed
+- After resume, the session can perform all operations normally
+- Use [pauseAsync](#pauseasync) to put a session into PAUSED state
+- If timeout is exceeded, returns with success=false
+
+**`See`**
+
+[pauseAsync](#pauseasync)
+
+___
+
 ### setLabels
 
 ▸ **setLabels**(`labels`): `Promise`\<`OperationResult`\>