AutomationSession

Added in version 2.18.

class AutomationSession(**properties: Any)

Superclasses: Object

Automation Session.

WebKitAutomationSession represents an automation session of a WebKitWebContext. When a new session is requested, a WebKitAutomationSession is created and the signal WebKitWebContext::automation-started is emitted with the WebKitAutomationSession as argument. Then, the automation client can request the session to create a new WebView to interact with it. When this happens the signal AutomationSession::create-web-view is emitted.

Methods

class AutomationSession

get_application_info() → ApplicationInfo

Get the the previously set AutomationSession.

Get the AutomationSession previously set with set_application_info().

Added in version 2.18.

get_id() → str

Get the unique identifier of a AutomationSession

Added in version 2.18.

set_application_info(info: ApplicationInfo) → None

Set the application information to session.

This information will be used by the driver service to match the requested capabilities with the actual application information. If this information is not provided to the session when a new automation session is requested, the creation might fail if the client requested a specific browser name or version. This will not have any effect when called after the automation session has been fully created, so this must be called in the callback of WebContext::automation-started signal.

Added in version 2.18.

Parameters:

info – a ApplicationInfo

Properties

class AutomationSession

props.id: str

The session unique identifier.

Added in version 2.18.

Signals

class AutomationSession.signals

create_web_view() → WebView

This signal is emitted when the automation client requests a new browsing context to interact with it. The callback handler should return a WebView created with WebView:is-controlled-by-automation construct property enabled and WebView:automation-presentation-type construct property set if needed.

If the signal is emitted with “tab” detail, the returned WebView should be a new web view added to a new tab of the current browsing context window. If the signal is emitted with “window” detail, the returned WebView should be a new web view added to a new window. When creating a new web view and there’s an active browsing context, the new window or tab shouldn’t be focused.

Added in version 2.18.

will_close() → None

This signal is emitted when the given automation session is about to finish. It allows clients to perform any cleanup tasks before the session is destroyed.

Added in version 2.46.