Sign Up

ComputerUseService

Properties:

  • service AddonProcessesService
  • mouse MouseService
  • keyboard KeyboardService
  • screen ScreenService
  • display DisplayService
  • a11y A11yService
  • recording RecordingService

Constructors

Constructor

new ComputerUseService(transport: ComputerUseTransport): ComputerUseService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • ComputerUseService

Methods

restart()

restart(): Promise<ComputerUseRestartResponse>;

Returns:

  • Promise<ComputerUseRestartResponse>

start()

start(): Promise<ComputerUseLifecycleResponse>;

Returns:

  • Promise<ComputerUseLifecycleResponse>

status()

status(): Promise<ComputerUseStatusResponse>;

Returns:

  • Promise<ComputerUseStatusResponse>

stop()

stop(): Promise<ComputerUseLifecycleResponse>;

Returns:

  • Promise<ComputerUseLifecycleResponse>

AddonProcessesService

Constructors

Constructor

new AddonProcessesService(transport: ComputerUseTransport): AddonProcessesService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • AddonProcessesService

Methods

errors()

errors(name: string): Promise<ComputerUseProcessErrorsResponse>;

Parameters:

  • name string

Returns:

  • Promise<ComputerUseProcessErrorsResponse>

logs()

logs(name: string): Promise<ComputerUseProcessLogsResponse>;

Parameters:

  • name string

Returns:

  • Promise<ComputerUseProcessLogsResponse>

restart()

restart(name: string): Promise<ComputerUseProcessRestartResponse>;

Parameters:

  • name string

Returns:

  • Promise<ComputerUseProcessRestartResponse>

status()

status(): Promise<Record<string, ComputerUseProcessStatus>>;

Returns:

  • Promise<Record<string, ComputerUseProcessStatus>>

status()

status(name: string): Promise<ComputerUseProcessRunningStatus>;

Parameters:

  • name string

Returns:

  • Promise<ComputerUseProcessRunningStatus>

status()

status(
   name?: string): Promise<Record<string, ComputerUseProcessStatus> | ComputerUseProcessRunningStatus>;

Parameters:

  • name? string

Returns:

  • Promise<Record<string, ComputerUseProcessStatus> | ComputerUseProcessRunningStatus>

A11yService

Constructors

Constructor

new A11yService(transport: ComputerUseTransport): A11yService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • A11yService

Methods

find()

find(request: ComputerUseA11yFindRequest): Promise<ComputerUseA11yFindResponse>;

Parameters:

  • request ComputerUseA11yFindRequest

Returns:

  • Promise<ComputerUseA11yFindResponse>

focus()

focus(request: ComputerUseA11yFocusRequest): Promise<void>;

Parameters:

  • request ComputerUseA11yFocusRequest

Returns:

  • Promise<void>

invoke()

invoke(request: ComputerUseA11yInvokeRequest): Promise<void>;

Parameters:

  • request ComputerUseA11yInvokeRequest

Returns:

  • Promise<void>

setValue()

setValue(request: ComputerUseA11ySetValueRequest): Promise<void>;

Parameters:

  • request ComputerUseA11ySetValueRequest

Returns:

  • Promise<void>

tree()

tree(options: ComputerUseA11yTreeOptions): Promise<ComputerUseA11yTreeResponse>;

Parameters:

  • options ComputerUseA11yTreeOptions

Returns:

  • Promise<ComputerUseA11yTreeResponse>

DisplayService

Constructors

Constructor

new DisplayService(transport: ComputerUseTransport): DisplayService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • DisplayService

Methods

info()

info(): Promise<ComputerUseDisplayInfoResponse>;

Returns:

  • Promise<ComputerUseDisplayInfoResponse>

windows()

windows(): Promise<ComputerUseDisplayWindowsResponse>;

Returns:

  • Promise<ComputerUseDisplayWindowsResponse>

KeyboardService

Constructors

Constructor

new KeyboardService(transport: ComputerUseTransport): KeyboardService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • KeyboardService

Methods

hotkey()

hotkey(request: ComputerUseKeyboardHotkeyRequest): Promise<void>;

Parameters:

  • request ComputerUseKeyboardHotkeyRequest

Returns:

  • Promise<void>

key()

key(request: ComputerUseKeyboardKeyRequest): Promise<void>;

Parameters:

  • request ComputerUseKeyboardKeyRequest

Returns:

  • Promise<void>

type()

type(request: ComputerUseKeyboardTypeRequest): Promise<void>;

Parameters:

  • request ComputerUseKeyboardTypeRequest

Returns:

  • Promise<void>

MouseService

Constructors

Constructor

new MouseService(transport: ComputerUseTransport): MouseService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • MouseService

Methods

click()

click(request: ComputerUseMouseClickRequest): Promise<ComputerUsePoint>;

Parameters:

  • request ComputerUseMouseClickRequest

Returns:

  • Promise<ComputerUsePoint>

drag()

drag(request: ComputerUseMouseDragRequest): Promise<ComputerUsePoint>;

Parameters:

  • request ComputerUseMouseDragRequest

Returns:

  • Promise<ComputerUsePoint>

move()

move(request: ComputerUseMouseMoveRequest): Promise<ComputerUsePoint>;

Parameters:

  • request ComputerUseMouseMoveRequest

Returns:

  • Promise<ComputerUsePoint>

position()

position(): Promise<ComputerUsePoint>;

Returns:

  • Promise<ComputerUsePoint>

scroll()

scroll(request: ComputerUseMouseScrollRequest): Promise<ComputerUseScrollResponse>;

Parameters:

  • request ComputerUseMouseScrollRequest

Returns:

  • Promise<ComputerUseScrollResponse>

RecordingService

Constructors

Constructor

new RecordingService(transport: ComputerUseTransport): RecordingService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • RecordingService

Methods

delete()

delete(id: string): Promise<void>;

Parameters:

  • id string

Returns:

  • Promise<void>

download()

download(id: string): Promise<Uint8Array>;

Parameters:

  • id string

Returns:

  • Promise<Uint8Array>

get()

get(id: string): Promise<ComputerUseRecording>;

Parameters:

  • id string

Returns:

  • Promise<ComputerUseRecording>

list()

list(): Promise<ComputerUseRecordingsResponse>;

Returns:

  • Promise<ComputerUseRecordingsResponse>

start()

start(request: ComputerUseRecordingStartRequest = {}): Promise<ComputerUseRecording>;

Parameters:

  • request ComputerUseRecordingStartRequest = {}

Returns:

  • Promise<ComputerUseRecording>

stop()

stop(request: ComputerUseRecordingStopRequest): Promise<ComputerUseRecording>;

Parameters:

  • request ComputerUseRecordingStopRequest

Returns:

  • Promise<ComputerUseRecording>

ScreenService

Constructors

Constructor

new ScreenService(transport: ComputerUseTransport): ScreenService;

Parameters:

  • transport ComputerUseTransport

Returns:

  • ScreenService

Methods

capture()

capture(
   options: { readonly showCursor?: boolean } = {}): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options { readonly showCursor?: boolean } = {}

Returns:

  • Promise<ComputerUseScreenshotResponse>

captureCompressed()

captureCompressed(
   options: ComputerUseScreenshotCompressedOptions = {}): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotCompressedOptions = {}

Returns:

  • Promise<ComputerUseScreenshotResponse>

region()

region(
   options: ComputerUseScreenshotRegionOptions): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotRegionOptions

Returns:

  • Promise<ComputerUseScreenshotResponse>

regionCompressed()

regionCompressed(
   options: ComputerUseScreenshotRegionCompressedOptions): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotRegionCompressedOptions

Returns:

  • Promise<ComputerUseScreenshotResponse>

screenshot()

screenshot(
   options: { readonly showCursor?: boolean } = {}): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options { readonly showCursor?: boolean } = {}

Returns:

  • Promise<ComputerUseScreenshotResponse>

screenshotCompressed()

screenshotCompressed(
   options: ComputerUseScreenshotCompressedOptions = {}): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotCompressedOptions = {}

Returns:

  • Promise<ComputerUseScreenshotResponse>

screenshotRegion()

screenshotRegion(
   options: ComputerUseScreenshotRegionOptions): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotRegionOptions

Returns:

  • Promise<ComputerUseScreenshotResponse>

screenshotRegionCompressed()

screenshotRegionCompressed(
   options: ComputerUseScreenshotRegionCompressedOptions): Promise<ComputerUseScreenshotResponse>;

Parameters:

  • options ComputerUseScreenshotRegionCompressedOptions

Returns:

  • Promise<ComputerUseScreenshotResponse>

ComputerUseTransport

Methods

delete()

delete<T>(path: string): Promise<T>;

Parameters:

  • path string

Returns:

  • Promise<T>

get()

get<T>(path: string, config?: { params?: Record<string, unknown> }): Promise<T>;

Parameters:

  • path string
  • config? { params?: Record<string, unknown> }

Returns:

  • Promise<T>

getBytes()

getBytes(path: string): Promise<ArrayBuffer>;

Parameters:

  • path string

Returns:

  • Promise<ArrayBuffer>

post()

post<T>(path: string, body?: unknown): Promise<T>;

Parameters:

  • path string
  • body? unknown

Returns:

  • Promise<T>

ComputerUseDesktopState

type ComputerUseDesktopState = Schema<"ComputerUseDesktopState">

ComputerUseDesktopFailureCode

type ComputerUseDesktopFailureCode = Schema<"ComputerUseDesktopFailureCode">

ComputerUseDesktopFailure

type ComputerUseDesktopFailure = OptionalizeNullable<Schema<"ComputerUseDesktopFailure">>

ComputerUseFailedStatus

Properties:

  • status 'inactive'
  • desktop 'failed'
  • cause ComputerUseDesktopFailure
  • extraFields? Record<string, unknown>

ComputerUseNotStartedStatus

Properties:

  • status 'inactive'
  • desktop 'not_started'
  • cause? never
  • extraFields? Record<string, unknown>

ComputerUseReadyStatus

Properties:

  • status 'active'
  • desktop 'ready'
  • cause? never
  • extraFields? Record<string, unknown>

ComputerUseRestartResponse

type ComputerUseRestartResponse = OptionalizeNullable<Schema<"ComputerUseRestartResponse">>

ComputerUseStartingStatus

Properties:

  • status 'inactive'
  • desktop 'starting'
  • cause? never
  • extraFields? Record<string, unknown>

ComputerUseA11yFindRequest

type ComputerUseA11yFindRequest = OptionalizeNullable<Schema<"ComputerUseA11yFindRequest">>

ComputerUseA11yFindResponse

type ComputerUseA11yFindResponse = Omit<OptionalizeNullable<Schema<"ComputerUseA11yFindResponse">>, 'matches'> & {
  matches: ComputerUseAccessibilityNode[]
}

ComputerUseA11yFocusRequest

Properties:

  • id string

ComputerUseA11yInvokeRequest

Properties:

  • id string
  • action? string

ComputerUseA11yNameMatch

type ComputerUseA11yNameMatch = 'exact' | 'substring' | 'regex'

ComputerUseA11yScope

type ComputerUseA11yScope = 'focused' | 'pid' | 'all'

ComputerUseA11ySetValueRequest

Properties:

  • id string
  • value string

ComputerUseA11yTreeOptions

Properties:

  • scope ComputerUseA11yScope
  • pid? number
  • maxDepth? number

ComputerUseA11yTreeResponse

type ComputerUseA11yTreeResponse = Omit<OptionalizeNullable<Schema<"ComputerUseA11yTreeResponse">>, 'root'> & {
  root: ComputerUseAccessibilityNode
}

ComputerUseAccessibilityBounds

type ComputerUseAccessibilityBounds = OptionalizeNullable<Schema<"ComputerUseAccessibilityBounds">>

ComputerUseAccessibilityNode

type ComputerUseAccessibilityNode = Omit<OptionalizeNullable<Schema<"ComputerUseAccessibilityNode">>, 'bounds' | 'children'> & {
  bounds: ComputerUseAccessibilityBounds
  children?: ComputerUseAccessibilityNode[]
}

ComputerUseDisplay

type ComputerUseDisplay = OptionalizeNullable<Schema<"ComputerUseDisplay">>

ComputerUseDisplayInfoResponse

type ComputerUseDisplayInfoResponse = OptionalizeNullable<Schema<"ComputerUseDisplayInfoResponse">>

ComputerUseDisplayWindowsResponse

type ComputerUseDisplayWindowsResponse = OptionalizeNullable<Schema<"ComputerUseDisplayWindowsResponse">>

ComputerUseKeyboardHotkeyRequest

type ComputerUseKeyboardHotkeyRequest = OptionalizeNullable<Schema<"ComputerUseKeyboardHotkeyRequest">>

ComputerUseKeyboardKeyRequest

type ComputerUseKeyboardKeyRequest = OptionalizeNullable<Schema<"ComputerUseKeyboardKeyRequest">>

ComputerUseKeyboardModifier

type ComputerUseKeyboardModifier = 'ctrl' | 'alt' | 'shift' | 'cmd'

ComputerUseKeyboardTypeRequest

type ComputerUseKeyboardTypeRequest = OptionalizeNullable<Schema<"ComputerUseKeyboardTypeRequest">>

ComputerUseLifecycleResponse

type ComputerUseLifecycleResponse = Omit<OptionalizeNullable<Schema<"ComputerUseLifecycleResponse">>, 'status'> & {
  status: ComputerUseProcessStatusMap
}

ComputerUseMouseButton

type ComputerUseMouseButton = 'left' | 'right' | 'middle'

ComputerUseMouseClickRequest

type ComputerUseMouseClickRequest = OptionalizeNullable<Schema<"ComputerUseMouseClickRequest">>

ComputerUseMouseDragRequest

type ComputerUseMouseDragRequest = OptionalizeNullable<Schema<"ComputerUseMouseDragRequest">>

ComputerUseMouseMoveRequest

type ComputerUseMouseMoveRequest = OptionalizeNullable<Schema<"ComputerUseMouseMoveRequest">>

ComputerUseMouseScrollRequest

type ComputerUseMouseScrollRequest = OptionalizeNullable<Schema<"ComputerUseMouseScrollRequest">>

ComputerUsePoint

type ComputerUsePoint = OptionalizeNullable<Schema<"ComputerUsePoint">>

ComputerUseProcessErrorsResponse

type ComputerUseProcessErrorsResponse = OptionalizeNullable<Schema<"ComputerUseProcessErrorsResponse">>

ComputerUseProcessLogsResponse

type ComputerUseProcessLogsResponse = OptionalizeNullable<Schema<"ComputerUseProcessLogsResponse">>

ComputerUseProcessRestartResponse

type ComputerUseProcessRestartResponse = OptionalizeNullable<Schema<"ComputerUseProcessRestartResponse">>

ComputerUseProcessRunningStatus

type ComputerUseProcessRunningStatus = OptionalizeNullable<Schema<"ComputerUseProcessRunningStatus">>

ComputerUseProcessStatus

type ComputerUseProcessStatus = OptionalizeNullable<Schema<"ComputerUseProcessStatus">> & Record<string, unknown>

ComputerUseRecording

type ComputerUseRecording = OptionalizeNullable<Schema<"ComputerUseRecording">>

ComputerUseRecordingsResponse

type ComputerUseRecordingsResponse = Omit<OptionalizeNullable<Schema<"ComputerUseRecordingsResponse">>, 'recordings'> & {
  recordings: ComputerUseRecording[]
}

ComputerUseRecordingStartRequest

type ComputerUseRecordingStartRequest = OptionalizeNullable<Schema<"ComputerUseRecordingStartRequest">>

ComputerUseRecordingStopRequest

type ComputerUseRecordingStopRequest = OptionalizeNullable<Schema<"ComputerUseRecordingStopRequest">>

ComputerUseScreenshotCompressedOptions

Properties:

  • format? ComputerUseScreenshotFormat
  • quality? number
  • scale? number
  • showCursor? boolean

ComputerUseScreenshotFormat

type ComputerUseScreenshotFormat = 'png' | 'jpeg'

ComputerUseScreenshotRegionCompressedOptions

Properties:

  • x number
  • y number
  • width number
  • height number
  • showCursor? boolean
  • format? ComputerUseScreenshotFormat
  • quality? number
  • scale? number

ComputerUseScreenshotRegionOptions

Properties:

  • x number
  • y number
  • width number
  • height number
  • showCursor? boolean

ComputerUseScreenshotResponse

type ComputerUseScreenshotResponse = Omit<OptionalizeNullable<Schema<"ComputerUseScreenshotResponse">>, 'cursorPosition'> & {
  cursorPosition?: ComputerUsePoint
}

ComputerUseScrollDirection

type ComputerUseScrollDirection = 'up' | 'down'

ComputerUseScrollResponse

type ComputerUseScrollResponse = OptionalizeNullable<Schema<"ComputerUseScrollResponse">>

ComputerUseStatusResponse

type ComputerUseStatusResponse = Omit<OptionalizeNullable<Schema<"ComputerUseStatusResponse">>, 'cause'> & {
  cause?: ComputerUseDesktopFailure
}

ComputerUseWindow

type ComputerUseWindow = OptionalizeNullable<Schema<"ComputerUseWindow">>

On this page

ComputerUseServiceConstructorsConstructorMethodsrestart()start()status()stop()AddonProcessesServiceConstructorsConstructorMethodserrors()logs()restart()status()status()status()A11yServiceConstructorsConstructorMethodsfind()focus()invoke()setValue()tree()DisplayServiceConstructorsConstructorMethodsinfo()windows()KeyboardServiceConstructorsConstructorMethodshotkey()key()type()MouseServiceConstructorsConstructorMethodsclick()drag()move()position()scroll()RecordingServiceConstructorsConstructorMethodsdelete()download()get()list()start()stop()ScreenServiceConstructorsConstructorMethodscapture()captureCompressed()region()regionCompressed()screenshot()screenshotCompressed()screenshotRegion()screenshotRegionCompressed()ComputerUseTransportMethodsdelete()get()getBytes()post()ComputerUseDesktopStateComputerUseDesktopFailureCodeComputerUseDesktopFailureComputerUseFailedStatusComputerUseNotStartedStatusComputerUseReadyStatusComputerUseRestartResponseComputerUseStartingStatusComputerUseA11yFindRequestComputerUseA11yFindResponseComputerUseA11yFocusRequestComputerUseA11yInvokeRequestComputerUseA11yNameMatchComputerUseA11yScopeComputerUseA11ySetValueRequestComputerUseA11yTreeOptionsComputerUseA11yTreeResponseComputerUseAccessibilityBoundsComputerUseAccessibilityNodeComputerUseDisplayComputerUseDisplayInfoResponseComputerUseDisplayWindowsResponseComputerUseKeyboardHotkeyRequestComputerUseKeyboardKeyRequestComputerUseKeyboardModifierComputerUseKeyboardTypeRequestComputerUseLifecycleResponseComputerUseMouseButtonComputerUseMouseClickRequestComputerUseMouseDragRequestComputerUseMouseMoveRequestComputerUseMouseScrollRequestComputerUsePointComputerUseProcessErrorsResponseComputerUseProcessLogsResponseComputerUseProcessRestartResponseComputerUseProcessRunningStatusComputerUseProcessStatusComputerUseRecordingComputerUseRecordingsResponseComputerUseRecordingStartRequestComputerUseRecordingStopRequestComputerUseScreenshotCompressedOptionsComputerUseScreenshotFormatComputerUseScreenshotRegionCompressedOptionsComputerUseScreenshotRegionOptionsComputerUseScreenshotResponseComputerUseScrollDirectionComputerUseScrollResponseComputerUseStatusResponseComputerUseWindow