Interface: ExternalDriver<C, Ctx>

▸ Optional addAuthCredential(credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, authenticatorId): Promise<void>

Inject a public key credential source into a virtual authenticator

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential

Parameters

Name	Type	Description
`credentialId`	`string`	the base64 encoded credential ID
`isResidentCredential`	`boolean`	if true, a client-side credential, otherwise a server-side credential
`rpId`	`string`	the relying party ID the credential is scoped to
`privateKey`	`string`	the base64 encoded private key package
`userHandle`	`string`	the base64 encoded user handle
`signCount`	`number`	the initial value for a signature counter
`authenticatorId`	`string`	-

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1960

addManagedDriver

▸ addManagedDriver(driver): void

Parameters

Name	Type
`driver`	`Driver`<`Constraints`, `StringRecord`<`any`>, `StringRecord`<`any`>, `DefaultCreateSessionResult`<`Constraints`>, `void`, `StringRecord`<`any`>>

Returns

void

Inherited from

Driver.addManagedDriver

Defined in

appium/packages/types/lib/driver.ts:667

addVirtualAuthenticator

▸ Optional addVirtualAuthenticator(protocol, transport, hasResidentKey?, hasUserVerification?, isUserConsenting?, isUserVerified?): Promise<string>

Add a virtual authenticator to a browser

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator

Parameters

Name	Type	Description
`protocol`	`"ctap/u2f"` \| `"ctap2"` \| `"ctap2_1"`	the protocol
`transport`	`string`	a valid AuthenticatorTransport value
`hasResidentKey?`	`boolean`	whether there is a resident key
`hasUserVerification?`	`boolean`	whether the authenticator has user verification
`isUserConsenting?`	`boolean`	whether it is a user consenting authenticator
`isUserVerified?`	`boolean`	whether the user is verified

Returns

Promise<string>

The authenticator ID

Defined in

appium/packages/types/lib/driver.ts:1931

assertFeatureEnabled

▸ assertFeatureEnabled(name): void

Parameters

Name	Type
`name`	`string`

Returns

void

Inherited from

Driver.assertFeatureEnabled

Defined in

appium/packages/types/lib/driver.ts:661

assignServer

▸ Optional assignServer(server, host, port, path): void

A helper function used to assign server information to the driver instance so the driver knows where the server is Running

Parameters

Name	Type	Description
`server`	`AppiumServer`	the server object
`host`	`string`	the server hostname
`port`	`number`	the server port
`path`	`string`	the server base url

Returns

void

Inherited from

Driver.assignServer

Defined in

appium/packages/types/lib/driver.ts:785

availableIMEEngines

▸ Optional availableIMEEngines(): Promise<string[]>

Get the list of IME engines

Deprecated

Returns

Promise<string[]>

The list of IME engines

Defined in

appium/packages/types/lib/driver.ts:1660

back

▸ Optional back(): Promise<void>

Navigate back in the page history

See

https://w3c.github.io/webdriver/#back

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:816

buttonDown

▸ Optional buttonDown(button?): Promise<void>

Trigger a mouse button down

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`button?`	`number`	the button ID

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1722

buttonUp

▸ Optional buttonUp(button?): Promise<void>

Trigger a mouse button up

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`button?`	`number`	the button ID

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1732

canProxy

▸ canProxy(sessionId?): boolean

Parameters

Name	Type
`sessionId?`	`string`

Returns

boolean

Inherited from

Driver.canProxy

Defined in

appium/packages/types/lib/driver.ts:665

clear

▸ Optional clear(elementId): Promise<void>

Clear the text/value of an editable element

See

https://w3c.github.io/webdriver/#element-clear

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1095

clearNewCommandTimeout

▸ clearNewCommandTimeout(): Promise<void>

Returns

Promise<void>

Inherited from

Driver.clearNewCommandTimeout

Defined in

appium/packages/types/lib/driver.ts:669

click

▸ Optional click(elementId): Promise<void>

Click/tap an element

See

https://w3c.github.io/webdriver/#element-click

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1087

clickCurrent

▸ Optional clickCurrent(button?): Promise<void>

Click the current mouse location

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`button?`	`number`	the button ID

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1742

closeWindow

▸ Optional closeWindow(): Promise<string[]>

Close the current browsing context (window)

See

https://w3c.github.io/webdriver/#close-window

Returns

Promise<string[]>

An array of window handles representing currently-open windows

Defined in

appium/packages/types/lib/driver.ts:863

createNewWindow

▸ Optional createNewWindow(type?): Promise<NewWindow>

Create a new browser window

See

https://w3c.github.io/webdriver/#new-window

Parameters

Name	Type	Description
`type?`	`NewWindowType`	a hint to the driver whether to create a "tab" or "window"

Returns

Promise<NewWindow>

An object containing the handle of the newly created window and its type

Defined in

appium/packages/types/lib/driver.ts:889

createSession

▸ createSession(w3cCaps1, w3cCaps2?, w3cCaps3?, driverData?): Promise<DefaultCreateSessionResult<C>>

Start a new automation session

See

https://w3c.github.io/webdriver/#new-session

Parameters

Name	Type	Description
`w3cCaps1`	`W3CDriverCaps`<`C`>	the new session capabilities
`w3cCaps2?`	`W3CDriverCaps`<`C`>	another place the new session capabilities could be sent (typically left undefined)
`w3cCaps3?`	`W3CDriverCaps`<`C`>	another place the new session capabilities could be sent (typically left undefined)
`driverData?`	`DriverData`[]	a list of DriverData objects representing other sessions running for this driver on the same Appium server. This information can be used to help ensure no conflict of resources

Returns

Promise<DefaultCreateSessionResult<C>>

The capabilities object representing the created session

Inherited from

Driver.createSession

Defined in

appium/packages/types/lib/driver.ts:428

deactivateIMEEngine

▸ Optional deactivateIMEEngine(): Promise<void>

Deactivate an IME engine

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1688

deleteCookie

▸ Optional deleteCookie(name): Promise<void>

Delete a named cookie

See

https://w3c.github.io/webdriver/#delete-cookie

Parameters

Name	Type	Description
`name`	`string`	the name of the cookie to delete

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1164

deleteCookies

▸ Optional deleteCookies(): Promise<void>

Delete all cookies

See

https://w3c.github.io/webdriver/#delete-all-cookies

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1170

deleteSession

▸ deleteSession(sessionId?, driverData?): Promise<void>

Stop an automation session

See

https://w3c.github.io/webdriver/#delete-session

Parameters

Name	Type	Description
`sessionId?`	`string`	the id of the session that is to be deleted
`driverData?`	`DriverData`[]	the driver data for other currently-running sessions

Returns

Promise<void>

Inherited from

Driver.deleteSession

Defined in

appium/packages/types/lib/driver.ts:442

doubleClick

▸ Optional doubleClick(): Promise<void>

Double-click the current mouse location

Deprecated

Use the Actions API instead

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1750

driverForSession

▸ driverForSession(sessionId): null | Core<C, StringRecord<any>>

Parameters

Name	Type
`sessionId`	`string`

Returns

null | Core<C, StringRecord<any>>

Inherited from

Driver.driverForSession

Defined in

appium/packages/types/lib/driver.ts:671

elementDisplayed

▸ Optional elementDisplayed(elementId): Promise<boolean>

Determine whether an element is displayed

See

https://w3c.github.io/webdriver/#element-displayedness

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<boolean>

True if any part of the element is rendered within the viewport, False otherwise

Defined in

appium/packages/types/lib/driver.ts:1079

elementEnabled

▸ Optional elementEnabled(elementId): Promise<boolean>

Determine whether an element is enabled

See

https://w3c.github.io/webdriver/#is-element-enabled

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<boolean>

True if the element is enabled, False otherwise

Defined in

appium/packages/types/lib/driver.ts:1049

elementSelected

▸ Optional elementSelected(elementId): Promise<boolean>

Determine if the reference element is selected or not

See

https://w3c.github.io/webdriver/#is-element-selected

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<boolean>

True if the element is selected, False otherwise

Defined in

appium/packages/types/lib/driver.ts:976

elementShadowRoot

▸ Optional elementShadowRoot(elementId): Promise<Element<string>>

Get the shadow root of an element

See

https://w3c.github.io/webdriver/#get-element-shadow-root

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element to retrieve the shadow root for

Returns

Promise<Element<string>>

The shadow root for an element, as an element

Defined in

appium/packages/types/lib/driver.ts:966

endCoverage

▸ Optional endCoverage(intent, path): Promise<void>

End platform-specific code coverage tracing

Deprecated

Parameters

Name	Type	Description
`intent`	`string`	the Android intent for the coverage activity
`path`	`string`	the path to place the results

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1626

equalsElement

▸ Optional equalsElement(elementId, otherElementId): Promise<boolean>

Check whether two elements are identical

Deprecated

Parameters

Name	Type	Description
`elementId`	`string`	the first element's ID
`otherElementId`	`string`	the second element's ID

Returns

Promise<boolean>

True if the elements are equal, false otherwise

Defined in

appium/packages/types/lib/driver.ts:1651

execute

▸ Optional execute(script, args): Promise<unknown>

Execute JavaScript (or some other kind of script) in the browser/app context

See

https://w3c.github.io/webdriver/#execute-script

Parameters

Name	Type	Description
`script`	`string`	the string to be evaluated as the script, which will be made the body of an anonymous function in the case of JS
`args`	`unknown`[]	the list of arguments to be applied to the script as a function

Returns

Promise<unknown>

The return value of the script execution

Defined in

appium/packages/types/lib/driver.ts:1116

executeAsync

▸ Optional executeAsync(script, args): Promise<unknown>

Execute JavaScript (or some other kind of script) in the browser/app context, asynchronously

See

https://w3c.github.io/webdriver/#execute-async-script

Parameters

Name	Type	Description
`script`	`string`	the string to be evaluated as the script, which will be made the body of an anonymous function in the case of JS
`args`	`unknown`[]	the list of arguments to be applied to the script as a function

Returns

Promise<unknown>

The promise resolution of the return value of the script execution (or an error object if the promise is rejected)

Defined in

appium/packages/types/lib/driver.ts:1129

executeCdp

▸ Optional executeCdp(cmd, params): Promise<unknown>

Execute a devtools command

Parameters

Name	Type	Description
`cmd`	`string`	the command
`params`	`unknown`	any command-specific command parameters

Returns

Promise<unknown>

The result of the command execution

Defined in

appium/packages/types/lib/driver.ts:1914

executeCommand

▸ executeCommand(cmd, ...args): Promise<any>

Execute a driver (WebDriver-protocol) command by its name as defined in the routes file

Parameters

Name	Type	Description
`cmd`	`string`	the name of the command
`...args`	`any`[]	arguments to pass to the command

Returns

Promise<any>

The result of running the command

Inherited from

Driver.executeCommand

Defined in

appium/packages/types/lib/driver.ts:717

executeMethod

▸ executeMethod<TArgs, TReturn>(script, args): Promise<TReturn>

Call an Execute Method by its name with the given arguments. This method will check that the driver has registered the method matching the name, and send it the arguments.

Type parameters

Name	Type
`TArgs`	extends readonly `any`[] \| readonly [`StringRecord`<`unknown`>] = `unknown`[]
`TReturn`	`unknown`

Parameters

Name	Type	Description
`script`	`string`	the name of the Execute Method
`args`	`TArgs`	a singleton array containing an arguments object

Returns

Promise<TReturn>

The result of calling the Execute Method

Inherited from

Driver.executeMethod

Defined in

appium/packages/types/lib/driver.ts:170

findElOrEls

▸ findElOrEls<Mult, Ctx>(strategy, selector, mult, context?): Promise<Mult extends true ? Element<string>[] : Element<string>>

A helper method that returns one or more UI elements based on the search criteria

Type parameters

Name	Type
`Mult`	extends `boolean`
`Ctx`	`any`

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector
`mult`	`Mult`	whether or not we want to find multiple elements
`context?`	`Ctx`	the element to use as the search context basis if desiredCapabilities

Returns

Promise<Mult extends true ? Element<string>[] : Element<string>>

A single element or list of elements

Inherited from

Driver.findElOrEls

Defined in

appium/packages/types/lib/driver.ts:294

findElOrElsWithProcessing

▸ findElOrElsWithProcessing<Mult, Ctx>(strategy, selector, mult, context?): Promise<Mult extends true ? Element<string>[] : Element<string>>

This is a wrapper for findElOrEls that validates locator strategies and implements the appium:printPageSourceOnFindFailure capability

Type parameters

Name	Type
`Mult`	extends `boolean`
`Ctx`	`any`

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector
`mult`	`Mult`	whether or not we want to find multiple elements
`context?`	`Ctx`	the element to use as the search context basis if desiredCapabilities

Returns

Promise<Mult extends true ? Element<string>[] : Element<string>>

A single element or list of elements

Inherited from

Driver.findElOrElsWithProcessing

Defined in

appium/packages/types/lib/driver.ts:312

findElement

▸ findElement(strategy, selector): Promise<Element<string>>

Find a UI element given a locator strategy and a selector, erroring if it can't be found

See

https://w3c.github.io/webdriver/#find-element

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific element

Returns

Promise<Element<string>>

The element object encoding the element id which can be used in element-related commands

Inherited from

Driver.findElement

Defined in

appium/packages/types/lib/driver.ts:210

findElementFromElement

▸ findElementFromElement(strategy, selector, elementId): Promise<Element<string>>

Find a UI element given a locator strategy and a selector, erroring if it can't be found. Only look for elements among the set of descendants of a given element

See

https://w3c.github.io/webdriver/#find-element-from-element

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific element
`elementId`	`string`	the id of the element to use as the search basis

Returns

Promise<Element<string>>

The element object encoding the element id which can be used in element-related commands

Inherited from

Driver.findElementFromElement

Defined in

appium/packages/types/lib/driver.ts:235

findElementFromShadowRoot

▸ Optional findElementFromShadowRoot(strategy, selector, shadowId): Promise<Element<string>>

Find an element from a shadow root

See

https://w3c.github.io/webdriver/#find-element-from-shadow-root

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific elements
`shadowId`	`string`	the id of the element to use as the search basis

Returns

Promise<Element<string>>

The element inside the shadow root matching the selector

Inherited from

Driver.findElementFromShadowRoot

Defined in

appium/packages/types/lib/driver.ts:263

findElements

▸ findElements(strategy, selector): Promise<Element<string>[]>

Find a a list of all UI elements matching a given a locator strategy and a selector

See

https://w3c.github.io/webdriver/#find-elements

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific elements

Returns

Promise<Element<string>[]>

A possibly-empty list of element objects

Inherited from

Driver.findElements

Defined in

appium/packages/types/lib/driver.ts:221

findElementsFromElement

▸ findElementsFromElement(strategy, selector, elementId): Promise<Element<string>[]>

Find a a list of all UI elements matching a given a locator strategy and a selector. Only look for elements among the set of descendants of a given element

See

https://w3c.github.io/webdriver/#find-elements-from-element

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific elements
`elementId`	`string`	the id of the element to use as the search basis

Returns

Promise<Element<string>[]>

A possibly-empty list of element objects

Inherited from

Driver.findElementsFromElement

Defined in

appium/packages/types/lib/driver.ts:248

findElementsFromShadowRoot

▸ Optional findElementsFromShadowRoot(strategy, selector, shadowId): Promise<Element<string>[]>

Find elements from a shadow root

See

https://w3c.github.io/webdriver/#find-element-from-shadow-root

Parameters

Name	Type	Description
`strategy`	`string`	the locator strategy
`selector`	`string`	the selector to combine with the strategy to find the specific elements
`shadowId`	`string`	the id of the element to use as the search basis

Returns

Promise<Element<string>[]>

A possibly empty list of elements inside the shadow root matching the selector

Inherited from

Driver.findElementsFromShadowRoot

Defined in

appium/packages/types/lib/driver.ts:278

fingerprint

▸ Optional fingerprint(fingerprintId): Promise<void>

Apply a synthetic fingerprint to the fingerprint detector of the device

Deprecated

Parameters

Name	Type	Description
`fingerprintId`	`number`	the numeric ID of the fingerprint to use

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1305

flick

▸ Optional flick(element?, xSpeed?, ySpeed?, xOffset?, yOffset?, speed?): Promise<void>

Perform a flick event at the location specified

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`element?`	`string`	the element to make coordinates relative to
`xSpeed?`	`number`	the horizontal flick speed (in driver-specific units)
`ySpeed?`	`number`	the vertical flick speed (in driver-specific units)
`xOffset?`	`number`	the x coordinate
`yOffset?`	`number`	the y coordinate
`speed?`	`number`	the speed (unclear how this relates to xSpeed and ySpeed)

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1808

forward

▸ Optional forward(): Promise<void>

Navigate forward in the page history

See

https://w3c.github.io/webdriver/#forward

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:822

fullScreenWindow

▸ Optional fullScreenWindow(): Promise<Rect>

Put the current window into full screen mode

See

https://w3c.github.io/webdriver/#fullscreen-window

Returns

Promise<Rect>

The actual Rect of the window after running the command

Defined in

appium/packages/types/lib/driver.ts:948

getActiveIMEEngine

▸ Optional getActiveIMEEngine(): Promise<string>

Get the active IME engine

Deprecated

Returns

Promise<string>

The name of the active engine

Defined in

appium/packages/types/lib/driver.ts:1670

getAlertText

▸ Optional getAlertText(): Promise<null | string>

Get the text of the displayed alert

See

https://w3c.github.io/webdriver/#get-alert-text

Returns

Promise<null | string>

The text of the alert

Defined in

appium/packages/types/lib/driver.ts:1204

getAttribute

▸ Optional getAttribute(name, elementId): Promise<null | string>

Retrieve the value of an element's attribute

See

https://w3c.github.io/webdriver/#get-element-attribute

Parameters

Name	Type	Description
`name`	`string`	the attribute name
`elementId`	`string`	the id of the element

Returns

Promise<null | string>

The attribute value

Defined in

appium/packages/types/lib/driver.ts:987

getAuthCredential

▸ Optional getAuthCredential(): Promise<Credential[]>

Get the list of public key credential sources

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials

Returns

Promise<Credential[]>

The list of Credentials

Defined in

appium/packages/types/lib/driver.ts:1976

getComputedLabel

▸ Optional getComputedLabel(elementId): Promise<null | string>

Get the accessible name/label of an element

See

https://w3c.github.io/webdriver/#get-computed-label

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<null | string>

The accessible name

Defined in

appium/packages/types/lib/driver.ts:1069

getComputedRole

▸ Optional getComputedRole(elementId): Promise<null | string>

Get the WAI-ARIA role of an element

See

https://w3c.github.io/webdriver/#get-computed-role

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<null | string>

The role

Defined in

appium/packages/types/lib/driver.ts:1059

getContexts

▸ Optional getContexts(): Promise<Ctx[]>

Get the list of available contexts

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts

Returns

Promise<Ctx[]>

The list of context names

Defined in

appium/packages/types/lib/driver.ts:1855

getCookie

▸ Optional getCookie(name): Promise<Cookie>

Get a cookie by name

See

https://w3c.github.io/webdriver/#get-named-cookie

Parameters

Name	Type	Description
`name`	`string`	the name of the cookie

Returns

Promise<Cookie>

A serialized cookie

Defined in

appium/packages/types/lib/driver.ts:1147

getCookies

▸ Optional getCookies(): Promise<Cookie[]>

Get all cookies known to the browsing context

See

https://w3c.github.io/webdriver/#get-all-cookies

Returns

Promise<Cookie[]>

A list of serialized cookies

Defined in

appium/packages/types/lib/driver.ts:1137

getCssProperty

▸ Optional getCssProperty(name, elementId): Promise<string>

Retrieve the value of a CSS property of an element

See

https://w3c.github.io/webdriver/#get-element-css-value

Parameters

Name	Type	Description
`name`	`string`	the CSS property name
`elementId`	`string`	the id of the element

Returns

Promise<string>

The property value

Defined in

appium/packages/types/lib/driver.ts:1009

getCurrentActivity

▸ Optional getCurrentActivity(): Promise<string>

Get the current activity name

Deprecated

Returns

Promise<string>

The activity name

Defined in

appium/packages/types/lib/driver.ts:1422

getCurrentContext

▸ Optional getCurrentContext(): Promise<null | Ctx>

Get the currently active context

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts

Returns

Promise<null | Ctx>

The context name

Defined in

appium/packages/types/lib/driver.ts:1839

getCurrentPackage

▸ Optional getCurrentPackage(): Promise<string>

Get the current active app package name/id

Deprecated

Returns

Promise<string>

The package name

Defined in

appium/packages/types/lib/driver.ts:1432

getDeviceTime

▸ Optional getDeviceTime(format?): Promise<string>

Get the current time on the device under timeouts

Parameters

Name	Type	Description
`format?`	`string`	the date/time format you would like the response into

Returns

Promise<string>

The formatted time

Defined in

appium/packages/types/lib/driver.ts:1241

getDisplayDensity

▸ Optional getDisplayDensity(): Promise<number>

Get the display's pixel density

Deprecated

Returns

Promise<number>

The density

Defined in

appium/packages/types/lib/driver.ts:1615

getElementRect

▸ Optional getElementRect(elementId): Promise<Rect>

Get the dimensions and position of an element

See

https://w3c.github.io/webdriver/#get-element-rect

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<Rect>

The Rect object containing x, y, width, and height properties

Defined in

appium/packages/types/lib/driver.ts:1039

getElementScreenshot

▸ Optional getElementScreenshot(elementId): Promise<string>

Get an image of a single element as rendered on screen

See

https://w3c.github.io/webdriver/#take-element-screenshot

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<string>

A base64-encoded string representing the PNG image data for the element rect

Defined in

appium/packages/types/lib/driver.ts:1230

getGeoLocation

▸ Optional getGeoLocation(): Promise<Location>

Get the virtual or real geographical location of a device

Returns

Promise<Location>

The location

Defined in

appium/packages/types/lib/driver.ts:1822

getLog

▸ getLog(logType): Promise<unknown[]>

Get the log for a given log type.

Parameters

Name	Type	Description
`logType`	`string`	Name/key of log type as defined in `supportedLogTypes`.

Returns

Promise<unknown[]>

Inherited from

Driver.getLog

Defined in

appium/packages/types/lib/driver.ts:344

getLogEvents

▸ getLogEvents(type?): Promise<EventHistory | Record<string, number>>

Get a list of events that have occurred in the current session

Parameters

Name	Type	Description
`type?`	`string` \| `string`[]	filter the returned events by including one or more types

Returns

Promise<EventHistory | Record<string, number>>

The event history for the session

Inherited from

Driver.getLogEvents

Defined in

appium/packages/types/lib/driver.ts:157

getLogTypes

▸ getLogTypes(): Promise<string[]>

Get available log types as a list of strings

Returns

Promise<string[]>

Inherited from

Driver.getLogTypes

Defined in

appium/packages/types/lib/driver.ts:337

getManagedDrivers

▸ getManagedDrivers(): Driver<Constraints, StringRecord<any>, StringRecord<any>, DefaultCreateSessionResult<Constraints>, void, StringRecord<any>>[]

Returns

Driver<Constraints, StringRecord<any>, StringRecord<any>, DefaultCreateSessionResult<Constraints>, void, StringRecord<any>>[]

Inherited from

Driver.getManagedDrivers

Defined in

appium/packages/types/lib/driver.ts:668

getName

▸ Optional getName(elementId): Promise<string>

Get the tag name of an element

See

https://w3c.github.io/webdriver/#get-element-tag-name

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<string>

The tag name

Defined in

appium/packages/types/lib/driver.ts:1029

getNetworkConnection

▸ Optional getNetworkConnection(): Promise<number>

Get the network connection state of a device

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes

Returns

Promise<number>

A number which is a bitmask representing categories like Data, Wifi, and Airplane mode status

Defined in

appium/packages/types/lib/driver.ts:1876

getOrientation

▸ Optional getOrientation(): Promise<string>

Get the device orientation

Returns

Promise<string>

The orientation string

Defined in

appium/packages/types/lib/driver.ts:1705

getPageIndex

▸ Optional getPageIndex(elementId): Promise<string>

Get the index of an element on the page

Deprecated

Parameters

Name	Type	Description
`elementId`	`string`	the element id

Returns

Promise<string>

The page index

Defined in

appium/packages/types/lib/driver.ts:1867

getPageSource

▸ getPageSource(): Promise<string>

Get the current page/app source as HTML/XML

See

https://w3c.github.io/webdriver/#get-page-source

Returns

Promise<string>

The UI hierarchy in a platform-appropriate format (e.g., HTML for a web page)

Inherited from

Driver.getPageSource

Defined in

appium/packages/types/lib/driver.ts:325

getPerformanceData

▸ Optional getPerformanceData(packageName, dataType, dataReadTimeout?): Promise<string[]>

Get the list of performance data associated with a given type

Deprecated

Parameters

Name	Type	Description
`packageName`	`string`	the package name / id of the app to retrieve data for
`dataType`	`string`	the performance data type; one of those retrieved in a call to getPerformanceDataTypes
`dataReadTimeout?`	`number`	how long to wait for data before timing out

Returns

Promise<string[]>

A list of performance data strings

Defined in

appium/packages/types/lib/driver.ts:1267

getPerformanceDataTypes

▸ Optional getPerformanceDataTypes(): Promise<string[]>

List the performance data types supported by this driver, which can be used in a call to get the performance data by type.

Deprecated

Returns

Promise<string[]>

The list of types

Defined in

appium/packages/types/lib/driver.ts:1252

getProperty

▸ Optional getProperty(name, elementId): Promise<null | string>

Retrieve the value of a named property of an element's JS object

See

https://w3c.github.io/webdriver/#get-element-property

Parameters

Name	Type	Description
`name`	`string`	the object property name
`elementId`	`string`	the id of the element

Returns

Promise<null | string>

The property value

Defined in

appium/packages/types/lib/driver.ts:998

getProxyAvoidList

▸ getProxyAvoidList(sessionId?): RouteMatcher[]

Parameters

Name	Type
`sessionId?`	`string`

Returns

RouteMatcher[]

Inherited from

Driver.getProxyAvoidList

Defined in

appium/packages/types/lib/driver.ts:664

getRotation

▸ Optional getRotation(): Promise<Rotation>

Get the current rotation state of the device

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation

Returns

Promise<Rotation>

The Rotation object consisting of x, y, and z rotation values (0 <= n <= 360)

Defined in

appium/packages/types/lib/driver.ts:1892

getScreenshot

▸ Optional getScreenshot(): Promise<string>

Get a screenshot of the current document as rendered

See

https://w3c.github.io/webdriver/#take-screenshot

Returns

Promise<string>

A base64-encoded string representing the PNG image data

Defined in

appium/packages/types/lib/driver.ts:1220

getSession

▸ getSession(): Promise<SingularSessionData<C, StringRecord<any>>>

Get the data for the current session

Returns

Promise<SingularSessionData<C, StringRecord<any>>>

A session data object

Inherited from

Driver.getSession

Defined in

appium/packages/types/lib/driver.ts:456

getSessions

▸ getSessions(): Promise<MultiSessionData<Constraints>[]>

Get data for all sessions running on an Appium server

Returns

Promise<MultiSessionData<Constraints>[]>

A list of session data objects

Inherited from

Driver.getSessions

Defined in

appium/packages/types/lib/driver.ts:449

getSettings

▸ getSettings(): Promise<StringRecord<any>>

Get the current settings for the session

Returns

Promise<StringRecord<any>>

The settings object

Inherited from

Driver.getSettings

Defined in

appium/packages/types/lib/driver.ts:386

getStatus

▸ getStatus(): Promise<any>

Summary

Retrieve the server's current status.

Description

Returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation.

The readiness state is represented by the ready property of the body, which is false if an attempt to create a session at the current time would fail. However, the value true does not guarantee that a New Session command will succeed.

Implementations may optionally include additional meta information as part of the body, but the top-level properties ready and message are reserved and must not be overwritten.

Example

// webdriver.io example
await driver.status();

driver.get_status()

driver.getStatus();

# ruby_lib example
remote_status

# ruby_lib_core example
@driver.remote_status

Returns

Promise<any>

Inherited from

Driver.getStatus

Defined in

appium/packages/types/lib/driver.ts:656

getSystemBars

▸ Optional getSystemBars(): Promise<unknown[]>

Get information from the system bars of a device

Deprecated

Returns

Promise<unknown[]>

An array of information objects of driver-specific shape

Defined in

appium/packages/types/lib/driver.ts:1605

getText

▸ Optional getText(elementId): Promise<string>

Get the text of an element as rendered

See

https://w3c.github.io/webdriver/#get-element-text

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element

Returns

Promise<string>

The text rendered for the element

Defined in

appium/packages/types/lib/driver.ts:1019

getTimeouts

▸ getTimeouts(): Promise<Record<string, number>>

Get the current timeouts

See

https://w3c.github.io/webdriver/#get-timeouts

Returns

Promise<Record<string, number>>

A map of timeout names to ms values

Inherited from

Driver.getTimeouts

Defined in

appium/packages/types/lib/driver.ts:77

getUrl

▸ Optional getUrl(): Promise<string>

Get the current url

See

https://w3c.github.io/webdriver/#get-current-url

Returns

Promise<string>

The url

Defined in

appium/packages/types/lib/driver.ts:810

getWindowHandle

▸ Optional getWindowHandle(): Promise<string>

Get the handle (id) associated with the current browser window

See

https://w3c.github.io/webdriver/#get-window-handle

Returns

Promise<string>

The handle string

Defined in

appium/packages/types/lib/driver.ts:855

getWindowHandles

▸ Optional getWindowHandles(): Promise<string[]>

Get a set of handles representing open browser windows

See

https://w3c.github.io/webdriver/#get-window-handles

Returns

Promise<string[]>

An array of window handles representing currently-open windows

Defined in

appium/packages/types/lib/driver.ts:879

getWindowRect

▸ Optional getWindowRect(): Promise<Rect>

Get the size and position of the current window

See

https://w3c.github.io/webdriver/#get-window-rect

Returns

Promise<Rect>

A Rect JSON object with x, y, width, and height properties

Defined in

appium/packages/types/lib/driver.ts:911

gsmCall

▸ Optional gsmCall(phoneNumber, action): Promise<void>

Simulate triggering a phone call from a phone number and having the device take an action in response

Deprecated

Parameters

Name	Type	Description
`phoneNumber`	`string`	the number to pretend the call is from
`action`	`string`	the action to take in response (accept, reject, etc...)

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1328

gsmSignal

▸ Optional gsmSignal(signalStrength): Promise<void>

Simulate setting the GSM signal strength for a cell phone

Deprecated

Parameters

Name	Type
`signalStrength`	`string`

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1338

gsmVoice

▸ Optional gsmVoice(state): Promise<void>

Do something with GSM voice (unclear; this should not be implemented anywhere)

Deprecated

Parameters

Name	Type	Description
`state`	`string`	the state

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1348

hideKeyboard

▸ Optional hideKeyboard(strategy?, key?, keyCode?, keyName?): Promise<void>

Attempt to hide a virtual keyboard

Parameters

Name	Type	Description
`strategy?`	`string`	the driver-specific name of a hiding strategy to follow
`key?`	`string`	the text of a key to use to hide the keyboard
`keyCode?`	`string`	a key code to trigger to hide the keyboard
`keyName?`	`string`	the name of a key to use to hide the keyboard

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1492

implicitWait

▸ implicitWait(ms): Promise<void>

Set the implicit wait timeout

Deprecated

Use timeouts instead

Parameters

Name	Type	Description
`ms`	`string` \| `number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.implicitWait

Defined in

appium/packages/types/lib/driver.ts:53

implicitWaitForCondition

▸ implicitWaitForCondition(condition): Promise<unknown>

Periodically retry an async function up until the currently set implicit wait timeout

Parameters

Name	Type	Description
`condition`	(...`args`: `any`[]) => `Promise`<`any`>	the behaviour to retry until it returns truthy

Returns

Promise<unknown>

The return value of the condition

Inherited from

Driver.implicitWaitForCondition

Defined in

appium/packages/types/lib/driver.ts:69

implicitWaitMJSONWP

▸ implicitWaitMJSONWP(ms): Promise<void>

Set the implicit wait value that was sent in via the JSONWP

Deprecated

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.implicitWaitMJSONWP

Defined in

appium/packages/types/lib/driver.ts:92

implicitWaitW3C

▸ implicitWaitW3C(ms): Promise<void>

Set the implicit wait value that was sent in via the W3C protocol

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.implicitWaitW3C

Defined in

appium/packages/types/lib/driver.ts:84

installApp

▸ Optional installApp(appPath, options?): Promise<void>

Install an app on a device

Parameters

Name	Type	Description
`appPath`	`string`	the absolute path to a local app or a URL of a downloadable app bundle
`options?`	`unknown`	driver-specific install options

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1440

isAppInstalled

▸ Optional isAppInstalled(appId): Promise<boolean>

Determine whether an app is installed

Parameters

Name	Type	Description
`appId`	`string`	the package or bundle ID of the application

Returns

Promise<boolean>

Defined in

appium/packages/types/lib/driver.ts:1471

isFeatureEnabled

▸ isFeatureEnabled(name): boolean

Parameters

Name	Type
`name`	`string`

Returns

boolean

Inherited from

Driver.isFeatureEnabled

Defined in

appium/packages/types/lib/driver.ts:660

isIMEActivated

▸ Optional isIMEActivated(): Promise<boolean>

Determine whether an IME is active

Deprecated

Returns

Promise<boolean>

True if the IME is activated

Defined in

appium/packages/types/lib/driver.ts:1680

isKeyboardShown

▸ Optional isKeyboardShown(): Promise<boolean>

Determine whether the keyboard is shown

Returns

Promise<boolean>

Whether the keyboard is shown

Defined in

appium/packages/types/lib/driver.ts:1499

isMjsonwpProtocol

▸ isMjsonwpProtocol(): boolean

Returns

boolean

Inherited from

Driver.isMjsonwpProtocol

Defined in

appium/packages/types/lib/driver.ts:659

isW3CProtocol

▸ isW3CProtocol(): boolean

Returns

boolean

Inherited from

Driver.isW3CProtocol

Defined in

appium/packages/types/lib/driver.ts:658

keyevent

▸ Optional keyevent(keycode, metastate?): Promise<void>

Simulate a keyevent on the device

Deprecated

Parameters

Name	Type	Description
`keycode`	`string`	the manufacturer defined keycode
`metastate?`	`string`	the combination of meta startUnexpectedShutdown

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1389

logCustomEvent

▸ logCustomEvent(vendor, event): Promise<void>

Add a custom-named event to the Appium event log

Parameters

Name	Type	Description
`vendor`	`string`	the name of the vendor or tool the event belongs to, to namespace the event
`event`	`string`	the name of the event itself

Returns

Promise<void>

Inherited from

Driver.logCustomEvent

Defined in

appium/packages/types/lib/driver.ts:148

logEvent

▸ logEvent(eventName): void

Parameters

Name	Type
`eventName`	`string`

Returns

void

Inherited from

Driver.logEvent

Defined in

appium/packages/types/lib/driver.ts:670

logExtraCaps

▸ logExtraCaps(caps): void

A helper function to log unrecognized capabilities to the console

Params

caps - the capabilities

Parameters

Name	Type
`caps`	`DriverCaps`<`C`>

Returns

void

Inherited from

Driver.logExtraCaps

Defined in

appium/packages/types/lib/driver.ts:774

longPressKeyCode

▸ Optional longPressKeyCode(keycode, metastate?, flags?): Promise<void>

Press a device hardware key by its code for a longer duration

Deprecated

Parameters

Name	Type	Description
`keycode`	`number`	the keycode
`metastate?`	`number`	the code denoting the simultaneous pressing of any meta keys (shift etc)
`flags?`	`number`	the code denoting the combination of extra flags

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1295

maximizeWindow

▸ Optional maximizeWindow(): Promise<Rect>

Run the window-manager specific 'maximize' operation on the current window

See

https://w3c.github.io/webdriver/#maximize-window

Returns

Promise<Rect>

The actual Rect of the window after running the command

Defined in

appium/packages/types/lib/driver.ts:932

minimizeWindow

▸ Optional minimizeWindow(): Promise<Rect>

Run the window-manager specific 'minimize' operation on the current window

See

https://w3c.github.io/webdriver/#minimize-window

Returns

Promise<Rect>

The actual Rect of the window after running the command

Defined in

appium/packages/types/lib/driver.ts:940

mobileRotation

▸ Optional mobileRotation(x, y, radius, rotation, touchCount, duration, elementId?): Promise<void>

Construct a rotation gesture? Unclear what this command does and it does not appear to be used

Deprecated

Use setRotation instead

Parameters

Name	Type	Description
`x`	`number`	the x coordinate of the rotation center
`y`	`number`	the y coordinate of the rotation center
`radius`	`number`	the radius of the rotation circle
`rotation`	`number`	the rotation angle? idk
`touchCount`	`number`	how many fingers to rotate
`duration`	`string`	-
`elementId?`	`string`	if we're rotating around an element

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1404

networkSpeed

▸ Optional networkSpeed(netspeed): Promise<void>

Set the network speed of the device

Deprecated

Parameters

Name	Type	Description
`netspeed`	`string`	the speed as a string, like '3G'

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1378

newCommandTimeout

▸ newCommandTimeout(ms): Promise<void>

Set Appium's new command timeout

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.newCommandTimeout

Defined in

appium/packages/types/lib/driver.ts:129

onUnexpectedShutdown

▸ onUnexpectedShutdown(handler): void

Parameters

Name	Type
`handler`	() => `any`

Returns

void

Inherited from

Driver.onUnexpectedShutdown

Defined in

appium/packages/types/lib/driver.ts:624

openNotifications

▸ Optional openNotifications(): Promise<void>

Open the notifications shade/screen

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1565

pageLoadTimeoutMJSONWP

▸ pageLoadTimeoutMJSONWP(ms): Promise<void>

Set the page load timeout value that was sent in via the JSONWP

Deprecated

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.pageLoadTimeoutMJSONWP

Defined in

appium/packages/types/lib/driver.ts:107

pageLoadTimeoutW3C

▸ pageLoadTimeoutW3C(ms): Promise<void>

Set the page load timeout value that was sent in via the W3C protocol

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.pageLoadTimeoutW3C

Defined in

appium/packages/types/lib/driver.ts:99

parseTimeoutArgument

▸ parseTimeoutArgument(ms): number

Get a timeout value from a number or a string

Parameters

Name	Type	Description
`ms`	`string` \| `number`	the timeout value as a number or a string

Returns

number

The timeout as a number in ms

Inherited from

Driver.parseTimeoutArgument

Defined in

appium/packages/types/lib/driver.ts:138

performActions

▸ Optional performActions(actions): Promise<void>

Perform touch or keyboard actions

See

https://w3c.github.io/webdriver/#perform-actions

Parameters

Name	Type	Description
`actions`	`ActionSequence`[]	the action sequence

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1178

postAcceptAlert

▸ Optional postAcceptAlert(): Promise<void>

Accept a simple dialog/alert

See

https://w3c.github.io/webdriver/#accept-alert

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1196

postDismissAlert

▸ Optional postDismissAlert(): Promise<void>

Dismiss a simple dialog/alert

See

https://w3c.github.io/webdriver/#dismiss-alert

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1190

powerAC

▸ Optional powerAC(state): Promise<void>

Set the AC-connected power state of the device

Deprecated

Parameters

Name	Type	Description
`state`	`string`	whether the device is connected to power or not

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1368

powerCapacity

▸ Optional powerCapacity(percent): Promise<void>

Set the simulated power capacity of the device

Deprecated

Parameters

Name	Type	Description
`percent`	`number`	how full the battery should become

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1358

pressKeyCode

▸ Optional pressKeyCode(keycode, metastate?, flags?): Promise<void>

Press a device hardware key by its code for the default duration

Deprecated

Parameters

Name	Type	Description
`keycode`	`number`	the keycode
`metastate?`	`number`	the code denoting the simultaneous pressing of any meta keys (shift etc)
`flags?`	`number`	the code denoting the combination of extra flags

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1283

proxyActive

▸ proxyActive(sessionId?): boolean

Parameters

Name	Type
`sessionId?`	`string`

Returns

boolean

Inherited from

Driver.proxyActive

Defined in

appium/packages/types/lib/driver.ts:663

proxyCommand

▸ Optional proxyCommand<TReq, TRes>(url, method, body?): Promise<TRes>

Proxy a command to a connected WebDriver server

Type parameters

Name	Type	Description
`TReq`	`any`	the type of the incoming body
`TRes`	`unknown`	the type of the return value

Parameters

Name	Type	Description
`url`	`string`	the incoming URL
`method`	`HTTPMethod`	the incoming HTTP method
`body?`	`TReq`	the incoming HTTP body

Returns

Promise<TRes>

The return value of the proxied command

Defined in

appium/packages/types/lib/driver.ts:2012

proxyRouteIsAvoided

▸ proxyRouteIsAvoided(sessionId, method, url): boolean

Parameters

Name	Type
`sessionId`	`string`
`method`	`string`
`url`	`string`

Returns

boolean

Inherited from

Driver.proxyRouteIsAvoided

Defined in

appium/packages/types/lib/driver.ts:666

pullFile

▸ Optional pullFile(path): Promise<string>

Retrieve the data from a file on the device at a given path

Parameters

Name	Type	Description
`path`	`string`	the remote path on the device to pull file data from

Returns

Promise<string>

The base64-encoded file data

Defined in

appium/packages/types/lib/driver.ts:1516

pullFolder

▸ Optional pullFolder(path): Promise<string>

Retrieve the data from a folder on the device at a given path

Parameters

Name	Type	Description
`path`	`string`	the remote path of a directory on the device

Returns

Promise<string>

The base64-encoded zip file of the directory contents

Defined in

appium/packages/types/lib/driver.ts:1525

pushFile

▸ Optional pushFile(path, data): Promise<void>

Push data to a file at a remote path on the device

Parameters

Name	Type	Description
`path`	`string`	the remote path on the device to create the file at
`data`	`string`	the base64-encoded data which will be decoded and written to `path`

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1507

queryAppState

▸ Optional queryAppState(appId): Promise<0 | 2 | 1 | 3 | 4>

Get the running state of an app

Parameters

Name	Type	Description
`appId`	`string`	the package or bundle ID of the application

Returns

Promise<0 | 2 | 1 | 3 | 4>

A number representing the state. 0 means not installed, 1 means not running, 2 means running in background but suspended, 3 means running in the background, and 4 means running in the foreground

Defined in

appium/packages/types/lib/driver.ts:1482

refresh

▸ Optional refresh(): Promise<void>

Refresh the page

See

https://w3c.github.io/webdriver/#refresh

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:828

releaseActions

▸ Optional releaseActions(): Promise<void>

Release all keys or buttons that are currently pressed

See

https://w3c.github.io/webdriver/#release-actions

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1184

removeAllAuthCredentials

▸ Optional removeAllAuthCredentials(): Promise<void>

Remove all auth credentials

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1982

removeApp

▸ Optional removeApp(appId, options?): Promise<void>

Remove / uninstall an app

Parameters

Name	Type	Description
`appId`	`string`	the package or bundle ID of the application
`options?`	`unknown`	driver-specific launch options

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1456

removeAuthCredential

▸ Optional removeAuthCredential(credentialId, authenticatorId): Promise<void>

Remove a specific auth credential

Parameters

Name	Type	Description
`credentialId`	`string`	the credential ID
`authenticatorId`	`string`	the authenticator ID

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1990

removeVirtualAuthenticator

▸ Optional removeVirtualAuthenticator(authenticatorId): Promise<void>

Remove a virtual authenticator

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator

Parameters

Name	Type	Description
`authenticatorId`	`string`	the ID returned in the call to add the authenticator

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1946

replaceValue

▸ Optional replaceValue(value, elementId): Promise<void>

Set the value of a text field but ensure the current value is replace and not appended

Deprecated

Parameters

Name	Type	Description
`value`	`string`	the text to set
`elementId`	`string`	the element to set it in

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1637

reset

▸ reset(): Promise<void>

Reset the current session (run the delete session and create session subroutines)

Deprecated

Use explicit session management commands instead

Returns

Promise<void>

Inherited from

Driver.reset

Defined in

appium/packages/types/lib/driver.ts:739

scriptTimeoutMJSONWP

▸ scriptTimeoutMJSONWP(ms): Promise<void>

Set the script timeout value that was sent in via the JSONWP

Deprecated

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.scriptTimeoutMJSONWP

Defined in

appium/packages/types/lib/driver.ts:122

scriptTimeoutW3C

▸ scriptTimeoutW3C(ms): Promise<void>

Set the script timeout value that was sent in via the W3C protocol

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

Promise<void>

Inherited from

Driver.scriptTimeoutW3C

Defined in

appium/packages/types/lib/driver.ts:114

sendSMS

▸ Optional sendSMS(phoneNumber, message): Promise<void>

Simulate sending an SMS message from a certain phone number to the device

Deprecated

Parameters

Name	Type	Description
`phoneNumber`	`string`	the number to pretend the message is from
`message`	`string`	the SMS text

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1316

sessionExists

▸ sessionExists(sessionId?): boolean

Parameters

Name	Type
`sessionId?`	`string`

Returns

boolean

Inherited from

Driver.sessionExists

Defined in

appium/packages/types/lib/driver.ts:657

setAlertText

▸ Optional setAlertText(text): Promise<void>

Set the text field of an alert prompt

See

https://w3c.github.io/webdriver/#send-alert-text

Parameters

Name	Type	Description
`text`	`string`	the text to send to the prompt

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1212

setContext

▸ Optional setContext(name, ...args): Promise<void>

Switch to a context by name

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts

Parameters

Name	Type	Description
`name`	`string`	the context name
`...args`	`any`[]	-

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1847

setCookie

▸ Optional setCookie(cookie): Promise<void>

Add a cookie to the browsing context

See

https://w3c.github.io/webdriver/#add-cookie

Parameters

Name	Type	Description
`cookie`	`Cookie`	the cookie data including properties like name, value, path, domain, secure, httpOnly, expiry, and samesite

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1156

setFrame

▸ Optional setFrame(id): Promise<void>

Switch the current browsing context to a frame

See

https://w3c.github.io/webdriver/#switch-to-frame

Parameters

Name	Type	Description
`id`	`null` \| `string` \| `number`	the frame id, index, or `null` (indicating the top-level context)

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:897

setGeoLocation

▸ Optional setGeoLocation(location): Promise<void>

Set the virtual geographical location of a device

Parameters

Name	Type	Description
`location`	`Partial`<`Location`>	the location including latitude and longitude

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1829

setImplicitWait

▸ setImplicitWait(ms): void

A helper method (not a command) used to set the implicit wait value

Parameters

Name	Type	Description
`ms`	`number`	the implicit wait in ms

Returns

void

Inherited from

Driver.setImplicitWait

Defined in

appium/packages/types/lib/driver.ts:60

setNetworkConnection

▸ Optional setNetworkConnection(type): Promise<void>

Set the network connection of the device

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes

Parameters

Name	Type	Description
`type`	`number`	the bitmask representing network state

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1884

setNewCommandTimeout

▸ setNewCommandTimeout(ms): void

Set the new command timeout

Parameters

Name	Type	Description
`ms`	`number`	the timeout in ms

Returns

void

Inherited from

Driver.setNewCommandTimeout

Defined in

appium/packages/types/lib/driver.ts:43

setOrientation

▸ Optional setOrientation(orientation): Promise<void>

Set the device orientation

Parameters

Name	Type	Description
`orientation`	`string`	the orientation string

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1712

setRotation

▸ Optional setRotation(x, y, z): Promise<void>

Set the device rotation state

See

https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation

Parameters

Name	Type	Description
`x`	`number`	the degree to which the device is rotated around the x axis (0 <= x <= 360)
`y`	`number`	the degree to which the device is rotated around the y axis (0 <= y <= 360)
`z`	`number`	the degree to which the device is rotated around the z axis (0 <= z <= 360)

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1902

setUrl

▸ Optional setUrl(url): Promise<void>

Navigate to a given url

See

https://w3c.github.io/webdriver/#navigate-to

Parameters

Name	Type	Description
`url`	`string`	the url

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:802

setUserAuthVerified

▸ Optional setUserAuthVerified(isUserVerified, authenticatorId): Promise<void>

Set the isUserVerified property of an authenticator

See

https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified

Parameters

Name	Type	Description
`isUserVerified`	`boolean`	the value of the isUserVerified property
`authenticatorId`	`string`	the authenticator id

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1999

setValue

▸ Optional setValue(text, elementId): Promise<void>

Send keystrokes to an element (or otherwise set its value)

See

https://w3c.github.io/webdriver/#element-send-keys

Parameters

Name	Type	Description
`text`	`string`	the text to send to the element
`elementId`	`string`	the id of the element

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1104

setWindow

▸ Optional setWindow(handle): Promise<void>

Switch to a specified window

See

https://w3c.github.io/webdriver/#switch-to-window

Parameters

Name	Type	Description
`handle`	`string`	the window handle of the window to make active

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:871

setWindowRect

▸ Optional setWindowRect(x, y, width, height): Promise<Rect>

Set the current window's size and position

See

https://w3c.github.io/webdriver/#set-window-rect

Parameters

Name	Type	Description
`x`	`number`	the screen coordinate for the new left edge of the window
`y`	`number`	the screen coordinate for the new top edge of the window
`width`	`number`	the width in pixels to resize the window to
`height`	`number`	the height in pixels to resize the window to

Returns

Promise<Rect>

The actual Rect of the window after running the command

Defined in

appium/packages/types/lib/driver.ts:924

startActivity

▸ Optional startActivity(appPackage, appActivity, appWaitPackage?, appWaitActivity?, intentAction?, intentCategory?, intentFlags?, optionalIntentArguments?, dontStopAppOnReset?): Promise<void>

Start an Android activity within an app

Deprecated

Parameters

Name	Type	Description
`appPackage`	`string`	the app package id
`appActivity`	`string`	the activity name
`appWaitPackage?`	`string`	the package id to wait for if different from the app package
`appWaitActivity?`	`string`	the activity name to wait for being active if different from appActivity
`intentAction?`	`string`	the action for the intent to use to start the activity
`intentCategory?`	`string`	the category for the intent
`intentFlags?`	`string`	-
`optionalIntentArguments?`	`string`	additional arguments to be passed to launching the intent
`dontStopAppOnReset?`	`boolean`	set to true to not stop the current app before launching the activity

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1585

startNewCommandTimeout

▸ startNewCommandTimeout(): Promise<void>

Start the timer for the New Command Timeout, which when it runs out, will stop the current session

Returns

Promise<void>

Inherited from

Driver.startNewCommandTimeout

Defined in

appium/packages/types/lib/driver.ts:731

startUnexpectedShutdown

▸ startUnexpectedShutdown(err?): Promise<void>

Signify to any owning processes that this driver encountered an error which should cause the session to terminate immediately (for example an upstream service failed)

Parameters

Name	Type	Description
`err?`	`Error`	the Error object which is causing the shutdown

Returns

Promise<void>

Inherited from

Driver.startUnexpectedShutdown

Defined in

appium/packages/types/lib/driver.ts:725

switchToParentFrame

▸ Optional switchToParentFrame(): Promise<void>

Set the current browsing context to the parent of the current context

See

https://w3c.github.io/webdriver/#switch-to-parent-frame

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:903

terminateApp

▸ Optional terminateApp(appId, options?): Promise<void>

Quit / terminate / stop a running application

Parameters

Name	Type	Description
`appId`	`string`	the package or bundle ID of the application
`options?`	`unknown`	driver-specific launch options

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1464

timeouts

▸ timeouts(type, ms, script?, pageLoad?, implicit?): Promise<void>

Set the various timeouts associated with a session

See

https://w3c.github.io/webdriver/#set-timeouts

Parameters

Name	Type	Description
`type`	`string`	used only for the old (JSONWP) command, the type of the timeout
`ms`	`string` \| `number`	used only for the old (JSONWP) command, the ms for the timeout
`script?`	`number`	the number in ms for the script timeout, used for the W3C command
`pageLoad?`	`number`	the number in ms for the pageLoad timeout, used for the W3C command
`implicit?`	`string` \| `number`	the number in ms for the implicit wait timeout, used for the W3C command

Returns

Promise<void>

Inherited from

Driver.timeouts

Defined in

appium/packages/types/lib/driver.ts:30

title

▸ Optional title(): Promise<string>

Get the current page title

See

https://w3c.github.io/webdriver/#get-title

Example

await driver.getTitle()

driver.title

driver.getTitle();

Returns

Promise<string>

The title

Defined in

appium/packages/types/lib/driver.ts:847

toggleData

▸ Optional toggleData(): Promise<void>

Toggle cell network data

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1541

toggleFlightMode

▸ Optional toggleFlightMode(): Promise<void>

Toggle airplane/flight mode for the device

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1533

toggleLocationServices

▸ Optional toggleLocationServices(): Promise<void>

Toggle location services for the device

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1557

toggleWiFi

▸ Optional toggleWiFi(): Promise<void>

Toggle WiFi radio status

Deprecated

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1549

touchDown

▸ Optional touchDown(x, y): Promise<void>

Perform a touch down event at the location specified

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`x`	`number`	the x coordinate
`y`	`number`	the y coordinate

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1761

touchLongClick

▸ Optional touchLongClick(elementId): Promise<void>

Perform a long touch down event at the location specified

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`elementId`	`string`	the id of the element to long touch

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1793

touchMove

▸ Optional touchMove(x, y): Promise<void>

Perform a touch move event at the location specified

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`x`	`number`	the x coordinate
`y`	`number`	the y coordinate

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1783

touchUp

▸ Optional touchUp(x, y): Promise<void>

Perform a touch up event at the location specified

Deprecated

Use the Actions API instead

Parameters

Name	Type	Description
`x`	`number`	the x coordinate
`y`	`number`	the y coordinate

Returns

Promise<void>

Defined in

appium/packages/types/lib/driver.ts:1772

validateDesiredCaps

▸ validateDesiredCaps(caps): boolean

Validate the capabilities used to start a session

Parameters

Name	Type	Description
`caps`	`DriverCaps`<`C`>	the capabilities

Returns

boolean

Whether or not the capabilities are valid

Inherited from

Driver.validateDesiredCaps

Defined in

appium/packages/types/lib/driver.ts:765

validateLocatorStrategy

▸ validateLocatorStrategy(strategy, webContext?): void

Parameters

Name	Type
`strategy`	`string`
`webContext?`	`boolean`

Returns

void

Inherited from

Driver.validateLocatorStrategy

Defined in

appium/packages/types/lib/driver.ts:662

Interface: ExternalDriver<C, Ctx>

Type parameters

Hierarchy

Table of contents

Properties

Methods

Properties

allowInsecure

Inherited from

Defined in

basePath

Inherited from

Defined in

caps

Inherited from

Defined in

cliArgs

Inherited from

Defined in

denyInsecure

Inherited from

Defined in

desiredCapConstraints

Inherited from

Defined in

driverData

Inherited from

Defined in

eventEmitter

Inherited from

Defined in

eventHistory

Inherited from

Defined in

helpers

Inherited from

Defined in

implicitWaitMs

Inherited from

Defined in

initialOpts

Inherited from

Defined in

isCommandsQueueEnabled

Inherited from

Defined in

locatorStrategies

Inherited from

Defined in

log

Inherited from

Defined in

newCommandTimeoutMs

Inherited from

Defined in

opts

Inherited from

Defined in

originalCaps

Inherited from

Defined in

protocol

Inherited from

Defined in

relaxedSecurityEnabled

Inherited from

Defined in

server

Inherited from

Defined in

serverHost

Inherited from

Defined in

serverPath

Inherited from

Defined in

serverPort

Inherited from

Defined in

sessionId