appium-uiautomator2-driver/build/lib/uiautomator2-server/session.d.ts

UiAutomator2 integration for Appium

import type { StringRecord } from '@appium/types';
import type { AndroidUiautomator2Driver } from '../driver';
import type { Uiautomator2SessionCaps, Uiautomator2StartSessionOpts } from '../types';
import { UiAutomator2Server } from './core';
/** Forwards a local port to the UiAutomator2 server port on the device. */
export declare function allocateSystemPort(this: AndroidUiautomator2Driver): Promise<void>;
/** Removes the UiAutomator2 server port forward. */
export declare function releaseSystemPort(this: AndroidUiautomator2Driver): Promise<void>;
/** Forwards a local port to the UiAutomator2 MJPEG server port on the device. */
export declare function allocateMjpegServerPort(this: AndroidUiautomator2Driver): Promise<void>;
/** Removes the UiAutomator2 MJPEG server port forward. */
export declare function releaseMjpegServerPort(this: AndroidUiautomator2Driver): Promise<void>;
/** Runs device preparation steps before the UiAutomator2 server session starts. */
export declare function performPreExecSetup(this: AndroidUiautomator2Driver): Promise<StringRecord | undefined>;
/** Installs and starts the UiAutomator2 server for the current session. */
export declare function performExecution(this: AndroidUiautomator2Driver, capsWithSessionInfo: StringRecord): Promise<void>;
/** Runs post-start steps after the UiAutomator2 server session is online. */
export declare function performPostExecSetup(this: AndroidUiautomator2Driver): Promise<void>;
/** Orchestrates UiAutomator2 server session startup and returns session capabilities. */
export declare function startSession(this: AndroidUiautomator2Driver, caps: Uiautomator2StartSessionOpts): Promise<Uiautomator2SessionCaps>;
/** Creates the UiAutomator2 server client and installs server APKs when needed. */
export declare function initServer(this: AndroidUiautomator2Driver): Promise<UiAutomator2Server>;
/** Returns the initialized UiAutomator2 server client or throws if it is missing. */
export declare function requireServer(this: AndroidUiautomator2Driver): UiAutomator2Server;
//# sourceMappingURL=session.d.ts.map