:right-sidebar: True

AutomationSession
===================================================================

.. currentmodule:: gi.repository.WebKit


.. versionadded:: 2.18




.. class:: AutomationSession(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.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
:obj:`~gi.repository.WebKit.WebView` to interact with it. When this happens the signal :obj:`~gi.repository.WebKit.AutomationSession`\::create-web-view
is emitted.




Methods
-------

.. rst-class:: interim-class

.. class:: AutomationSession
   :no-index:


   .. method:: get_application_info() -> ~gi.repository.WebKit.ApplicationInfo

      Get the the previously set :obj:`~gi.repository.WebKit.AutomationSession`\.

      Get the :obj:`~gi.repository.WebKit.AutomationSession` previously set with :func:`~gi.repository.WebKit.AutomationSession.set_application_info`.



      .. versionadded:: 2.18








   .. method:: get_id() -> str

      Get the unique identifier of a :obj:`~gi.repository.WebKit.AutomationSession`



      .. versionadded:: 2.18








   .. method:: set_application_info(info: ~gi.repository.WebKit.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
      :obj:`~gi.repository.WebKit.WebContext`\::automation-started signal.



      .. versionadded:: 2.18





      :param info: a :obj:`~gi.repository.WebKit.ApplicationInfo`








Properties
----------

.. rst-class:: interim-class

.. class:: AutomationSession
   :no-index:
   

   .. attribute:: props.id
      :type: str

      The session unique identifier.


      .. versionadded:: 2.18









Signals
-------

.. rst-class:: interim-class

.. class:: AutomationSession.signals
   :no-index:
   

   .. method:: create_web_view() -> ~gi.repository.WebKit.WebView

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

      If the signal is emitted with "tab" detail, the returned :obj:`~gi.repository.WebKit.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 :obj:`~gi.repository.WebKit.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.


      .. versionadded:: 2.18








   .. method:: 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.


      .. versionadded:: 2.46