Class Computers

Hierarchy

APIResource
- Computers

Index

Constructors

Properties

Methods

create retrieve keyboardInteraction mouseInteraction screenInteraction

Constructors

constructor

new Computers(client: Runloop): Computers
Parameters
- client: Runloop
Returns Computers
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body?: ComputerCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<ComputerView>
Create a Computer and begin the boot process. The Computer will initially launch in the 'provisioning' state while Runloop allocates the necessary infrastructure. It will transition to the 'initializing' state while the booted Computer runs any Runloop or user defined set up scripts. Finally, the Computer will transition to the 'running' state when it is ready for use.
Parameters
- Optionalbody: ComputerCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerView>
- Defined in src/resources/devboxes/computers.ts:16
create(options?: RequestOptions<unknown>): APIPromise<ComputerView>
Create a Computer and begin the boot process. The Computer will initially launch in the 'provisioning' state while Runloop allocates the necessary infrastructure. It will transition to the 'initializing' state while the booted Computer runs any Runloop or user defined set up scripts. Finally, the Computer will transition to the 'running' state when it is ready for use.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerView>
- Defined in src/resources/devboxes/computers.ts:17

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ComputerView>
Get Computer Details.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerView>
- Defined in src/resources/devboxes/computers.ts:31

keyboardInteraction

keyboardInteraction(
    id: string,
    body: ComputerKeyboardInteractionParams,
    options?: RequestOptions<unknown>,
): APIPromise<ComputerKeyboardInteractionResponse>
Perform the specified keyboard interaction on the Computer identified by the given ID.
Parameters
- id: string
- body: ComputerKeyboardInteractionParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerKeyboardInteractionResponse>
- Defined in src/resources/devboxes/computers.ts:39

mouseInteraction

mouseInteraction(
    id: string,
    body: ComputerMouseInteractionParams,
    options?: RequestOptions<unknown>,
): APIPromise<ComputerMouseInteractionResponse>
Perform the specified mouse interaction on the Computer identified by the given ID.
Parameters
- id: string
- body: ComputerMouseInteractionParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerMouseInteractionResponse>
- Defined in src/resources/devboxes/computers.ts:51

screenInteraction

screenInteraction(
    id: string,
    body: ComputerScreenInteractionParams,
    options?: RequestOptions<unknown>,
): APIPromise<ComputerScreenInteractionResponse>
Perform the specified screen interaction on the Computer identified by the given ID.
Parameters
- id: string
- body: ComputerScreenInteractionParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ComputerScreenInteractionResponse>
- Defined in src/resources/devboxes/computers.ts:63