Skip to content

Interface: Core<C, Settings>

@appium/types.Core

Methods and properties which both AppiumDriver and BaseDriver inherit.

This should not be used directly by external code.

Type parameters

Name Type
C extends Constraints
Settings extends StringRecord = StringRecord

Hierarchy

  • Core

↳ Driver

Table of contents

Properties

Methods

Properties

allowInsecure

• allowInsecure: string[]

Defined in

node_modules/@appium/types/lib/driver.ts:603

basePath

• basePath: string

Defined in

node_modules/@appium/types/lib/driver.ts:601

denyInsecure

• denyInsecure: string[]

Defined in

node_modules/@appium/types/lib/driver.ts:604

driverData

• driverData: DriverData

Defined in

node_modules/@appium/types/lib/driver.ts:612

eventEmitter

• eventEmitter: EventEmitter

Defined in

node_modules/@appium/types/lib/driver.ts:609

eventHistory

• eventHistory: EventHistory

Defined in

node_modules/@appium/types/lib/driver.ts:614

helpers

• helpers: DriverHelpers

Defined in

node_modules/@appium/types/lib/driver.ts:600

implicitWaitMs

• implicitWaitMs: number

Defined in

node_modules/@appium/types/lib/driver.ts:606

initialOpts

• initialOpts: Partial<DriverOpts<C>>

Defined in

node_modules/@appium/types/lib/driver.ts:598

isCommandsQueueEnabled

• isCommandsQueueEnabled: boolean

Defined in

node_modules/@appium/types/lib/driver.ts:613

locatorStrategies

• locatorStrategies: string[]

Defined in

node_modules/@appium/types/lib/driver.ts:607

log

• log: AppiumLogger

Defined in

node_modules/@appium/types/lib/driver.ts:611

newCommandTimeoutMs

• newCommandTimeoutMs: number

Defined in

node_modules/@appium/types/lib/driver.ts:605

opts

• opts: DriverOpts<C>

Defined in

node_modules/@appium/types/lib/driver.ts:597

protocol

• Optional protocol: string

Defined in

node_modules/@appium/types/lib/driver.ts:599

relaxedSecurityEnabled

• relaxedSecurityEnabled: boolean

Defined in

node_modules/@appium/types/lib/driver.ts:602

sessionId

• sessionId: null | string

Defined in

node_modules/@appium/types/lib/driver.ts:596

settings

• settings: IDeviceSettings<Settings>

Defined in

node_modules/@appium/types/lib/driver.ts:610

shouldValidateCaps

• shouldValidateCaps: boolean

Defined in

node_modules/@appium/types/lib/driver.ts:595

webLocatorStrategies

• webLocatorStrategies: string[]

Defined in

node_modules/@appium/types/lib/driver.ts:608

Methods

addManagedDriver

▸ addManagedDriver(driver): void

Parameters

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

Returns

void

Defined in

node_modules/@appium/types/lib/driver.ts:658

assertFeatureEnabled

▸ assertFeatureEnabled(name): void

Parameters

Name Type
name string

Returns

void

Defined in

node_modules/@appium/types/lib/driver.ts:652

canProxy

▸ canProxy(sessionId?): boolean

Parameters

Name Type
sessionId? string

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:656

clearNewCommandTimeout

▸ clearNewCommandTimeout(): Promise<void>

Returns

Promise<void>

Defined in

node_modules/@appium/types/lib/driver.ts:660

driverForSession

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

Parameters

Name Type
sessionId string

Returns

null | Core<C, StringRecord<any>>

Defined in

node_modules/@appium/types/lib/driver.ts:662

getManagedDrivers

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

Returns

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

Defined in

node_modules/@appium/types/lib/driver.ts:659

getProxyAvoidList

▸ getProxyAvoidList(sessionId?): RouteMatcher[]

Parameters

Name Type
sessionId? string

Returns

RouteMatcher[]

Defined in

node_modules/@appium/types/lib/driver.ts:655

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>

Defined in

node_modules/@appium/types/lib/driver.ts:647

isFeatureEnabled

▸ isFeatureEnabled(name): boolean

Parameters

Name Type
name string

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:651

isMjsonwpProtocol

▸ isMjsonwpProtocol(): boolean

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:650

isW3CProtocol

▸ isW3CProtocol(): boolean

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:649

logEvent

▸ logEvent(eventName): void

Parameters

Name Type
eventName string

Returns

void

Defined in

node_modules/@appium/types/lib/driver.ts:661

onUnexpectedShutdown

▸ onUnexpectedShutdown(handler): void

Parameters

Name Type
handler () => any

Returns

void

Defined in

node_modules/@appium/types/lib/driver.ts:615

proxyActive

▸ proxyActive(sessionId?): boolean

Parameters

Name Type
sessionId? string

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:654

proxyRouteIsAvoided

▸ proxyRouteIsAvoided(sessionId, method, url): boolean

Parameters

Name Type
sessionId string
method string
url string

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:657

sessionExists

▸ sessionExists(sessionId?): boolean

Parameters

Name Type
sessionId? string

Returns

boolean

Defined in

node_modules/@appium/types/lib/driver.ts:648

validateLocatorStrategy

▸ validateLocatorStrategy(strategy, webContext?): void

Parameters

Name Type
strategy string
webContext? boolean

Returns

void

Defined in

node_modules/@appium/types/lib/driver.ts:653