appium-remote-debugger/build/lib/mixins/events.d.ts

Appium proxy for Remote Debugger protocol

import type { RemoteDebugger } from '../remote-debugger';
import type { EventListener } from '../types';
export declare const events: {
    readonly EVENT_PAGE_CHANGE: "remote_debugger_page_change";
    readonly EVENT_FRAMES_DETACHED: "remote_debugger_frames_detached";
    readonly EVENT_DISCONNECT: "remote_debugger_disconnect";
};
/**
 * Adds a client event listener to the RPC client and tracks it for later removal.
 * The listener will be called when the specified event is emitted by the remote debugger.
 *
 * @param eventName - The name of the event to listen for.
 * @param listener - The event listener function to call when the event is emitted.
 */
export declare function addClientEventListener(this: RemoteDebugger, eventName: string, listener: EventListener): void;
/**
 * Removes all client event listeners for the specified event name from the RPC client.
 * This will stop listening for the event and clean up the tracked listeners.
 *
 * @param eventName - The name of the event to stop listening for.
 */
export declare function removeClientEventListener(this: RemoteDebugger, eventName: string): void;
/**
 * Starts listening for JavaScript console messages by registering listeners
 * for Console.messageAdded and Console.messageRepeatCountUpdated events.
 *
 * @param listener - The event listener function to call when console messages are received.
 */
export declare function startConsole(this: RemoteDebugger, listener: EventListener): void;
/**
 * Stops listening for JavaScript console messages by removing listeners
 * for Console.messageAdded and Console.messageRepeatCountUpdated events.
 */
export declare function stopConsole(this: RemoteDebugger): void;
/**
 * Starts listening for network events by registering a listener for NetworkEvent.
 * This aggregates all Network.* events into a single NetworkEvent.
 *
 * @param listener - The event listener function to call when network events are received.
 */
export declare function startNetwork(this: RemoteDebugger, listener: EventListener): void;
/**
 * Stops listening for network events by removing the listener for NetworkEvent.
 */
export declare function stopNetwork(this: RemoteDebugger): void;
//# sourceMappingURL=events.d.ts.map