Class Device

constructor

• new Device(webDriverClient, bundleId, timeoutOpts, provider): Device

• Parameters

  • webDriverClient: Client
  • bundleId: undefined | string
  • timeoutOpts: TimeoutOptions
  • provider: string

  Returns Device

beta

activateApp

• activateApp(bundleId?): Promise<void>

• Parameters

  • OptionalbundleId: string

  Returns Promise<void>

close

• close(): Promise<void>

• Closes the automation session. This is called automatically after each test.

  Usage:

  await device.close();
  Copy

  Returns Promise<void>

getById

• getById(text, options?): AppwrightLocator

• Locate an element on the screen with accessibility identifier. This method defaults to a substring match, and this can be overridden by setting the exact option to true.

  Usage:

  const element = await device.getById("signup_button");
  Copy

  Parameters

  • text: string

    string to search for
  • options: {
        exact?: boolean;
    } = {}

    • Optionalexact?: boolean

  Returns AppwrightLocator

getByText

• getByText(text, options?): AppwrightLocator

• Locate an element on the screen with text content. This method defaults to a substring match, and this be overridden by setting the exact option to true.

  Usage:

  // with string
  const submitButton = device.getByText("Submit");
  
  // with RegExp
  const counter = device.getByText(/^Counter: \d+/);
  Copy

  Parameters

  • text: string | RegExp

    string or regular expression to search for
  • options: {
        exact?: boolean;
    } = {}

    • Optionalexact?: boolean

  Returns AppwrightLocator

getByXpath

• getByXpath(xpath): AppwrightLocator

• Locate an element on the screen with xpath.

  Usage:

  const element = await device.getByXpath(`//android.widget.Button[@text="Confirm"]`);
  Copy

  Parameters

  • xpath: string

    xpath to locate the element

  Returns AppwrightLocator

getClipboardText

• getClipboardText(): Promise<string>

• Retrieves text content from the clipboard of the mobile device. This is useful after a "copy to clipboard" action has been performed. This returns base64 encoded string.

  Usage:

  const clipboardText = await device.getClipboardText();
  Copy

  Returns Promise<string>

  Returns the text content of the clipboard in base64 encoded string.

getPlatform

• getPlatform(): Platform

• Helper method to detect the mobile OS running on the device.

  Usage:

  const platform = device.getPlatform();
  Copy

  Returns Platform

  "android" or "ios"

locator

• locator(__namedParameters): AppwrightLocator

• Parameters

  • __namedParameters: {
        findStrategy: string;
        selector: string;
        textToMatch?: string | RegExp;
    }

    • findStrategy: string

    • selector: string

    • OptionaltextToMatch?: string | RegExp

  Returns AppwrightLocator

pause

• pause(): Promise<void>

• Returns Promise<void>

screenshot

• screenshot(): Promise<string>

• Get a screenshot of the current screen as a base64 encoded string.

  Returns Promise<string>

scroll

• scroll(): Promise<void>

• [iOS Only] Scroll the screen from 0.2 to 0.8 of the screen height. This can be used for controlled scroll, for auto scroll checkout scroll method from locator.

  Usage:

  await device.scroll();
  Copy

  Returns Promise<void>

sendKeyStrokes

• sendKeyStrokes(value): Promise<void>

• Send keys to already focused input field. To fill input fields using the selectors use sendKeyStrokes method from locator

  Parameters

  • value: string

  Returns Promise<void>

setMockCameraView

• setMockCameraView(imagePath): Promise<void>

• Sets a mock camera view using the specified image. This injects a mock image into the camera view. Currently, this functionality is supported only for BrowserStack.

  Usage:

  await device.setMockCameraView(`screenshot.png`);
  Copy

  Parameters

  • imagePath: string

    path to the image file that will be used as the mock camera view.

  Returns Promise<void>

tap

• tap(coordinates): Promise<void>

• Tap on the screen at the given coordinates, specified as x and y. The top left corner of the screen is { x: 0, y: 0 }.

  Usage:

  await device.tap({ x: 100, y: 100 });
  Copy

  Parameters

  • coordinates: {
        x: number;
        y: number;
    }

    to tap on

    • x: number

    • y: number

  Returns Promise<void>

terminateApp

• terminateApp(bundleId?): Promise<void>

• Parameters

  • OptionalbundleId: string

  Returns Promise<void>

waitForTimeout

• waitForTimeout(timeout): Promise<void>

• Parameters

  • timeout: number

  Returns Promise<void>