Skip to content

Interface: ISettingsCommands<T>

@appium/types.ISettingsCommands

Type parameters

Name Type
T extends StringRecord = StringRecord

Hierarchy

  • ISettingsCommands

Driver

Table of contents

Properties

Methods

Properties

updateSettings

updateSettings: (settings: StringRecord<any>) => Promise<void>

Type declaration

▸ (settings): Promise<void>

Update the session's settings dictionary with a new settings object

Parameters
Name Type Description
settings StringRecord<any> A key-value map of setting names to values. Settings not named in the map will not have their value adjusted.
Returns

Promise<void>

Defined in

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

Methods

getSettings

getSettings(): Promise<T>

Get the current settings for the session

Returns

Promise<T>

The settings object

Defined in

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