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

• allowInsecure
• basePath
• denyInsecure
• driverData
• eventEmitter
• eventHistory
• helpers
• implicitWaitMs
• initialOpts
• isCommandsQueueEnabled
• locatorStrategies
• log
• newCommandTimeoutMs
• opts
• protocol
• relaxedSecurityEnabled
• sessionId
• settings
• shouldValidateCaps
• webLocatorStrategies

Methods

• addManagedDriver
• assertFeatureEnabled
• canProxy
• clearNewCommandTimeout
• driverForSession
• getManagedDrivers
• getProxyAvoidList
• getStatus
• isFeatureEnabled
• isMjsonwpProtocol
• isW3CProtocol
• logEvent
• onUnexpectedShutdown
• proxyActive
• proxyRouteIsAvoided
• sessionExists
• validateLocatorStrategy

Properties

allowInsecure

• allowInsecure: string[]

Defined in

packages/types/lib/driver.ts:587

---

basePath

• basePath: string

Defined in

packages/types/lib/driver.ts:585

---

denyInsecure

• denyInsecure: string[]

Defined in

packages/types/lib/driver.ts:588

---

driverData

• driverData: DriverData

Defined in

packages/types/lib/driver.ts:596

---

eventEmitter

• eventEmitter: EventEmitter

Defined in

packages/types/lib/driver.ts:593

---

eventHistory

• eventHistory: EventHistory

Defined in

packages/types/lib/driver.ts:598

---

helpers

• helpers: DriverHelpers

Defined in

packages/types/lib/driver.ts:584

---

implicitWaitMs

• implicitWaitMs: number

Defined in

packages/types/lib/driver.ts:590

---

initialOpts

• initialOpts: Object

Type declaration

Name	Type
address	string
allowCors	NonNullable<undefined | boolean>
allowInsecure	AllowInsecureConfig
basePath	string
callbackAddress	undefined | string
callbackPort	number
debugLogSpacing	NonNullable<undefined | boolean>
defaultCapabilities	undefined | DefaultCapabilitiesConfig
denyInsecure	DenyInsecureConfig
driver	undefined | DriverConfig
fastReset?	boolean
keepAliveTimeout	number
localTimezone	NonNullable<undefined | boolean>
logFile	undefined | string
logFilters	undefined | LogFiltersConfig
logNoColors	NonNullable<undefined | boolean>
logTimestamp	NonNullable<undefined | boolean>
loglevel	NonNullable<undefined | LogLevelConfig>
longStacktrace	NonNullable<undefined | boolean>
noPermsCheck	NonNullable<undefined | boolean>
nodeconfig	undefined | NodeconfigConfig
plugin	undefined | PluginConfig
port	number
relaxedSecurityEnabled	NonNullable<undefined | boolean>
sessionOverride	NonNullable<undefined | boolean>
skipUninstall?	boolean
strictCaps	NonNullable<undefined | boolean>
tmpDir	undefined | string
traceDir	undefined | string
useDrivers	UseDriversConfig
usePlugins	UsePluginsConfig
webhook	undefined | string

Defined in

packages/types/lib/driver.ts:582

---

isCommandsQueueEnabled

• isCommandsQueueEnabled: boolean

Defined in

packages/types/lib/driver.ts:597

---

locatorStrategies

• locatorStrategies: string[]

Defined in

packages/types/lib/driver.ts:591

---

log

• log: AppiumLogger

Defined in

packages/types/lib/driver.ts:595

---

newCommandTimeoutMs

• newCommandTimeoutMs: number

Defined in

packages/types/lib/driver.ts:589

---

opts

• opts: DriverOpts<C>

Defined in

packages/types/lib/driver.ts:581

---

protocol

• Optional protocol: Protocol

Defined in

packages/types/lib/driver.ts:583

---

relaxedSecurityEnabled

• relaxedSecurityEnabled: boolean

Defined in

packages/types/lib/driver.ts:586

---

sessionId

• sessionId: null | string

Defined in

packages/types/lib/driver.ts:580

---

settings

• settings: IDeviceSettings<Settings>

Defined in

packages/types/lib/driver.ts:594

---

shouldValidateCaps

• shouldValidateCaps: boolean

Defined in

packages/types/lib/driver.ts:579

---

webLocatorStrategies

• webLocatorStrategies: string[]

Defined in

packages/types/lib/driver.ts:592

Methods

addManagedDriver

▸ addManagedDriver(driver): void

Parameters

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

Returns

void

Defined in

packages/types/lib/driver.ts:642

---

assertFeatureEnabled

▸ assertFeatureEnabled(name): void

Parameters

Name	Type
name	string

Returns

void

Defined in

packages/types/lib/driver.ts:636

---

canProxy

▸ canProxy(sessionId?): boolean

Parameters

Name	Type
sessionId?	string

Returns

boolean

Defined in

packages/types/lib/driver.ts:640

---

clearNewCommandTimeout

▸ clearNewCommandTimeout(): Promise<void>

Returns

Promise<void>

Defined in

packages/types/lib/driver.ts:644

---

driverForSession

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

Parameters

Name	Type
sessionId	string

Returns

null | Core<Constraints, StringRecord>

Defined in

packages/types/lib/driver.ts:646

---

getManagedDrivers

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

Returns

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

Defined in

packages/types/lib/driver.ts:643

---

getProxyAvoidList

▸ getProxyAvoidList(sessionId?): RouteMatcher[]

Parameters

Name	Type
sessionId?	string

Returns

RouteMatcher[]

Defined in

packages/types/lib/driver.ts:639

---

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

packages/types/lib/driver.ts:631

---

isFeatureEnabled

▸ isFeatureEnabled(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Defined in

packages/types/lib/driver.ts:635

---

isMjsonwpProtocol

▸ isMjsonwpProtocol(): boolean

Returns

boolean

Defined in

packages/types/lib/driver.ts:634

---

isW3CProtocol

▸ isW3CProtocol(): boolean

Returns

boolean

Defined in

packages/types/lib/driver.ts:633

---

logEvent

▸ logEvent(eventName): void

Parameters

Name	Type
eventName	string

Returns

void

Defined in

packages/types/lib/driver.ts:645

---

onUnexpectedShutdown

▸ onUnexpectedShutdown(handler): void

Parameters

Name	Type
handler	() => any

Returns

void

Defined in

packages/types/lib/driver.ts:599

---

proxyActive

▸ proxyActive(sessionId?): boolean

Parameters

Name	Type
sessionId?	string

Returns

boolean

Defined in

packages/types/lib/driver.ts:638

---

proxyRouteIsAvoided

▸ proxyRouteIsAvoided(sessionId, method, url, body?): boolean

Parameters

Name	Type
sessionId	string
method	string
url	string
body?	any

Returns

boolean

Defined in

packages/types/lib/driver.ts:641

---

sessionExists

▸ sessionExists(sessionId?): boolean

Parameters

Name	Type
sessionId?	string

Returns

boolean

Defined in

packages/types/lib/driver.ts:632

---

validateLocatorStrategy

▸ validateLocatorStrategy(strategy, webContext?): void

Parameters

Name	Type
strategy	string
webContext?	boolean

Returns

void

Defined in

packages/types/lib/driver.ts:637