wuying-agentbay-sdk 0.12.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

@@ -36,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` = `""`

package/docs/api/computer-use/computer.md

@@ -18,7 +18,7 @@ keyboard input, screen capture, and window management. It enables automated UI t
 
 ### MouseButton
 
-Mouse button constants: Left, Right, Middle
+Mouse button constants: Left, Right, Middle, DoubleLeft
 
 ### ScrollDirection
 
@@ -99,7 +99,7 @@ ___
 
 ### clickMouse
 
-▸ **clickMouse**(`x`, `y`, `button?`): `Promise`\<`BoolResult`\>
+▸ **clickMouse**(`x`, `y`, `button?`): `Promise`\<`OperationResult`\>
 
 Click mouse at specified coordinates.
 
@@ -113,7 +113,7 @@ Click mouse at specified coordinates.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -166,7 +166,7 @@ ___
 
 ### dragMouse
 
-▸ **dragMouse**(`fromX`, `fromY`, `toX`, `toY`, `button?`): `Promise`\<`BoolResult`\>
+▸ **dragMouse**(`fromX`, `fromY`, `toX`, `toY`, `button?`): `Promise`\<`OperationResult`\>
 
 Drag mouse from one position to another.
 
@@ -182,7 +182,7 @@ Drag mouse from one position to another.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -265,7 +265,7 @@ if (result.success) {
 
 ### inputText
 
-▸ **inputText**(`text`): `Promise`\<`BoolResult`\>
+▸ **inputText**(`text`): `Promise`\<`OperationResult`\>
 
 Input text at the current cursor position.
 
@@ -277,7 +277,7 @@ Input text at the current cursor position.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -328,13 +328,13 @@ ___
 
 ### listVisibleApps
 
-▸ **listVisibleApps**(): `Promise`\<`any`\>
+▸ **listVisibleApps**(): `Promise`\<`ProcessListResult`\>
 
 Lists all visible applications.
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`ProcessListResult`\>
 
 Promise resolving to result containing array of visible application processes
 
@@ -420,7 +420,7 @@ ___
 
 ### moveMouse
 
-▸ **moveMouse**(`x`, `y`): `Promise`\<`BoolResult`\>
+▸ **moveMouse**(`x`, `y`): `Promise`\<`OperationResult`\>
 
 Move mouse to specified coordinates.
 
@@ -433,7 +433,7 @@ Move mouse to specified coordinates.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -454,7 +454,7 @@ ___
 
 ### pressKeys
 
-▸ **pressKeys**(`keys`, `hold?`): `Promise`\<`BoolResult`\>
+▸ **pressKeys**(`keys`, `hold?`): `Promise`\<`OperationResult`\>
 
 Press one or more keys.
 
@@ -467,7 +467,7 @@ Press one or more keys.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -487,7 +487,7 @@ ___
 
 ### releaseKeys
 
-▸ **releaseKeys**(`keys`): `Promise`\<`BoolResult`\>
+▸ **releaseKeys**(`keys`): `Promise`\<`OperationResult`\>
 
 Release previously pressed keys.
 
@@ -499,7 +499,7 @@ Release previously pressed keys.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -614,7 +614,7 @@ ___
 
 ### scroll
 
-▸ **scroll**(`x`, `y`, `direction?`, `amount?`): `Promise`\<`BoolResult`\>
+▸ **scroll**(`x`, `y`, `direction?`, `amount?`): `Promise`\<`OperationResult`\>
 
 Scroll at specified coordinates.
 
@@ -629,7 +629,7 @@ Scroll at specified coordinates.
 
 #### Returns
 
-`Promise`\<`BoolResult`\>
+`Promise`\<`OperationResult`\>
 
 Promise resolving to result with success status
 
@@ -648,7 +648,7 @@ ___
 
 ### startApp
 
-▸ **startApp**(`startCmd`, `workDirectory?`, `activity?`): `Promise`\<`any`\>
+▸ **startApp**(`startCmd`, `workDirectory?`, `activity?`): `Promise`\<`ProcessListResult`\>
 
 Starts the specified application.
 
@@ -662,7 +662,7 @@ Starts the specified application.
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`ProcessListResult`\>
 
 Promise resolving to result containing array of started processes
 
@@ -682,7 +682,7 @@ ___
 
 ### stopAppByCmd
 
-▸ **stopAppByCmd**(`cmd`): `Promise`\<`any`\>
+▸ **stopAppByCmd**(`cmd`): `Promise`\<`BoolResult`\>
 
 Stops an application by stop command.
 
@@ -694,7 +694,7 @@ Stops an application by stop command.
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`BoolResult`\>
 
 Promise resolving to result with success status
 
@@ -714,7 +714,7 @@ ___
 
 ### stopAppByPID
 
-▸ **stopAppByPID**(`pid`): `Promise`\<`any`\>
+▸ **stopAppByPID**(`pid`): `Promise`\<`BoolResult`\>
 
 Stops an application by process ID.
 
@@ -726,7 +726,7 @@ Stops an application by process ID.
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`BoolResult`\>
 
 Promise resolving to result with success status
 
@@ -747,7 +747,7 @@ ___
 
 ### stopAppByPName
 
-▸ **stopAppByPName**(`pname`): `Promise`\<`any`\>
+▸ **stopAppByPName**(`pname`): `Promise`\<`BoolResult`\>
 
 Stops an application by process name.
 
@@ -759,7 +759,7 @@ Stops an application by process name.
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`BoolResult`\>
 
 Promise resolving to result with success status