appium-espresso-driver
Version:
Espresso integration for Appium
127 lines • 6.21 kB
TypeScript
/**
* Emulates key press event.
*
* @this {import('../driver').EspressoDriver}
* @param {number} keycode A valid Android key code. See https://developer.android.com/reference/android/view/KeyEvent
* for the list of available key codes
* @param {number} [metastate] An integer in which each bit set to 1 represents a pressed meta key. See
* https://developer.android.com/reference/android/view/KeyEvent for more details.
* @param {number} [flags] Flags for the particular key event. See
* https://developer.android.com/reference/android/view/KeyEvent for more details.
* @param {boolean} [isLongPress=false] Whether to emulate long key press
*/
export function mobilePressKey(this: import("../driver").EspressoDriver, keycode: number, metastate?: number, flags?: number, isLongPress?: boolean): Promise<void>;
/**
* @this {import('../driver').EspressoDriver}
* @returns {Promise<import('../types').DeviceInfo>}
*/
export function mobileGetDeviceInfo(this: import("../driver").EspressoDriver): Promise<import("../types").DeviceInfo>;
/**
* @this {import('../driver').EspressoDriver}
* @see https://github.com/appium/appium-espresso-driver?tab=readme-ov-file#mobile-istoastvisible
* @param {string} text
* @param {boolean} [isRegexp]
*/
export function mobileIsToastVisible(this: import("../driver").EspressoDriver, text: string, isRegexp?: boolean): Promise<any>;
/**
* @this {import('../driver').EspressoDriver}
* @returns {Promise<number>}
*/
export function getDisplayDensity(this: import("../driver").EspressoDriver): Promise<number>;
/**
* API to invoke methods defined in Android app.
*
* Example data
* {
* target: 'activity',
* methods:
* [
* {
* name: "someMethod",
* },
* {
* name: "anotherMethod",
* args:
* [
* {value: "Lol", type: 'java.lang.CharSequence'},
* {value: 1, type: 'int'}
* ]
* }
* ]
* }
*
* In above example, method "someMethod" will be invoked on 'activity'. On the result, "anotherMethod" will be invoked
* "target" can be either 'activity', 'application' or 'element'
* If target is set to 'application', methods will be invoked on application class
* If target is set to 'activity', methods will be invoked on current activity
* If target is set to 'element', 'elementId' must be specified
*
* - Only 'Public' methods can be invoked. ('open' modifire is necessary in Kotlin)
* - following primitive types are supported: "int", "boolean", "byte", "short", "long", "float", "char"
* - Non-primitive types with fully qualified name "java.lang.*" is also supported:
* Eg. "java.lang.CharSequence", "java.lang.String", "java.lang.Integer", "java.lang.Float",
* "java.lang.Double", "java.lang.Boolean", "java.lang.Long", "java.lang.Short",
* "java.lang.Character" etc...
*
*
* @throws {Error} if target is not 'activity' or 'application'
* @throws {Error} if a method is not found with given argument types
* @this {import('../driver').EspressoDriver}
* @see https://github.com/appium/appium-espresso-driver?tab=readme-ov-file#mobile-backdoor
* @param {string} target
* @param {import('@appium/types').StringRecord[]} methods
* @param {string} [elementId]
* @return {Promise<any>} the result of the last method in the invocation chain.
* If method return type is void, then "<VOID>" will be returned
*/
export function mobileBackdoor(this: import("../driver").EspressoDriver, target: string, methods: import("@appium/types").StringRecord[], elementId?: string): Promise<any>;
/**
* Execute UiAutomator2 commands to drive out of app areas.
* strategy can be one of: "clazz", "res", "text", "textContains", "textEndsWith", "textStartsWith",
* "desc", "descContains", "descEndsWith", "descStartsWith", "pkg"
*
* action can be one of: "click", "longClick", "getText", "getContentDescription", "getClassName",
* "getResourceName", "getVisibleBounds", "getVisibleCenter", "getApplicationPackage",
* "getChildCount", "clear", "isCheckable", "isChecked", "isClickable", "isEnabled",
* "isFocusable", "isFocused", "isLongClickable", "isScrollable", "isSelected"
* @this {import('../driver').EspressoDriver}
* @see https://github.com/appium/appium-espresso-driver?tab=readme-ov-file#mobile-uiautomator
* @param {string} strategy
* @param {string} locator
* @param {string} action
* @param {number} [index]
*/
export function mobileUiautomator(this: import("../driver").EspressoDriver, strategy: string, locator: string, action: string, index?: number): Promise<any>;
/**
* Execute UiAutomator2 command to return the UI dump when AUT is in background.
* @this {import('../driver').EspressoDriver}
* @throws {Error} if uiautomator view dump is unsuccessful
* @returns {Promise<string>} uiautomator DOM xml as string
*/
export function mobileUiautomatorPageSource(this: import("../driver").EspressoDriver): Promise<string>;
/**
* @typedef {Object} SettingsOptions
* @property {!string|number|boolean} Object Settings parameters that is available in
* https://github.com/appium/appium-espresso-driver#settings-api or enabled plugins.
*/
/**
* Apply the given settings to the espresso driver and the espresso server.
* Errors by the espresso server will be printed as log, but it does not return an error message.
* @param {SettingsOptions} settings
* @this {import('../driver').EspressoDriver}
*/
export function updateSettings(this: import("../driver").EspressoDriver, settings: SettingsOptions): Promise<void>;
/**
* @this {import('../driver').EspressoDriver}
*/
export function getSettings(this: import("../driver").EspressoDriver): Promise<{
[x: string]: any;
}>;
export type SettingsOptions = {
/**
* Settings parameters that is available in
* https://github.com/appium/appium-espresso-driver#settings-api or enabled plugins.
*/
Object: string | number | boolean;
};
//# sourceMappingURL=misc.d.ts.map