Skip to content
View as Markdown

ComputerUse

Initialize a new ComputerUse instance.

Constructors

new ComputerUse()

def initialize(sandbox_id:, toolbox_api:)

Initialize a new ComputerUse instance.

Parameters:

  • sandbox_id String - The ID of the sandbox
  • toolbox_api DaytonaApiClient:ToolboxApi - API client for sandbox operations

Returns:

  • ComputerUse - a new instance of ComputerUse

Methods

sandbox_id()

def sandbox_id()

Returns:

  • String - The ID of the sandbox

toolbox_api()

def toolbox_api()

Returns:

  • DaytonaApiClient:ToolboxApi - API client for sandbox operations

mouse()

def mouse()

Returns:

  • Mouse - Mouse operations interface

keyboard()

def keyboard()

Returns:

  • Keyboard - Keyboard operations interface

screenshot()

def screenshot()

Returns:

  • Screenshot - Screenshot operations interface

display()

def display()

Returns:

  • Display - Display operations interface

start()

def start()

Starts all computer use processes (Xvfb, xfce4, x11vnc, novnc).

Returns:

  • DaytonaApiClient:ComputerUseStartResponse - Computer use start response

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

result = sandbox.computer_use.start
puts "Computer use processes started: #{result.message}"

stop()

def stop()

Stops all computer use processes.

Returns:

  • DaytonaApiClient:ComputerUseStopResponse - Computer use stop response

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

result = sandbox.computer_use.stop
puts "Computer use processes stopped: #{result.message}"

status()

def status()

Gets the status of all computer use processes.

Returns:

  • DaytonaApiClient:ComputerUseStatusResponse - Status information about all VNC desktop processes

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

response = sandbox.computer_use.get_status
puts "Computer use status: #{response.status}"

get_process_status()

def get_process_status(process_name:)

Gets the status of a specific VNC process.

Parameters:

  • process_name String - Name of the process to check

Returns:

  • DaytonaApiClient:ProcessStatusResponse - Status information about the specific process

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

xvfb_status = sandbox.computer_use.get_process_status("xvfb")
no_vnc_status = sandbox.computer_use.get_process_status("novnc")

restart_process()

def restart_process(process_name:)

Restarts a specific VNC process.

Parameters:

  • process_name String - Name of the process to restart

Returns:

  • DaytonaApiClient:ProcessRestartResponse - Process restart response

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

result = sandbox.computer_use.restart_process("xfce4")
puts "XFCE4 process restarted: #{result.message}"

get_process_logs()

def get_process_logs(process_name:)

Gets logs for a specific VNC process.

Parameters:

  • process_name String - Name of the process to get logs for

Returns:

  • DaytonaApiClient:ProcessLogsResponse - Process logs

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

logs = sandbox.computer_use.get_process_logs("novnc")
puts "NoVNC logs: #{logs}"

get_process_errors()

def get_process_errors(process_name:)

Gets error logs for a specific VNC process.

Parameters:

  • process_name String - Name of the process to get error logs for

Returns:

  • DaytonaApiClient:ProcessErrorsResponse - Process error logs

Raises:

  • Daytona:Sdk:Error - If the operation fails

Examples:

errors = sandbox.computer_use.get_process_errors("x11vnc")
puts "X11VNC errors: #{errors}"