appium-xcuitest-driver
Version:
Appium driver for iOS using XCUITest for backend
36 lines • 1.52 kB
TypeScript
/**
* Lists and exports device crash reports (`.ips`) on real hardware over RemoteXPC.
*
* Requires **iOS/tvOS 18+** and the optional **`appium-ios-remotexpc`** package.
* Used by {@link IOSCrashLog} for BiDi / `crashlog` collection on real devices.
*/
export declare class CrashReportsClient {
private readonly crashReportsService;
private readonly remoteXPCConnection;
private constructor();
/**
* Opens a RemoteXPC crash-reports service for the given UDID.
*
* @param udid - Real device UDID
* @param useRemoteXPC - Must be `true`; callers derive this from `isIos18OrNewer` / session options
* @throws {Error} If `useRemoteXPC` is false, or RemoteXPC setup fails
*/
static create(udid: string, useRemoteXPC: boolean): Promise<CrashReportsClient>;
/**
* @returns Basenames of crash report files on the device (e.g. `MyApp-2024-01-01-120000.ips`)
*/
listCrashes(): Promise<string[]>;
/**
* Pulls a single crash report off the device into a local folder.
*
* @param name - Crash file basename as returned by {@link CrashReportsClient.listCrashes}
* @param dstFolder - Existing local directory to write into
* @throws {Error} If the named report is not found on the device
*/
exportCrash(name: string, dstFolder: string): Promise<void>;
/**
* Tears down the crash-reports service and closes the RemoteXPC connection.
*/
close(): Promise<void>;
}
//# sourceMappingURL=crash-reports-client.d.ts.map