GI.WebKit2.Objects.AutomationSession

No description available in the introspection data.

Exported types

newtype AutomationSession

Memory-managed wrapper type.

Constructors

AutomationSession (ManagedPtr AutomationSession)

Instances

GObject AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

Methods

gobjectType :: IO GType

HasParentTypes AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

type ParentTypes AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

type ParentTypes AutomationSession = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf AutomationSession o) => IsAutomationSession o

Type class for types which can be safely cast to AutomationSession, for instance with toAutomationSession.

Instances

(GObject o, IsDescendantOf AutomationSession o) => IsAutomationSession o

Defined in GI.WebKit2.Objects.AutomationSession

toAutomationSession :: (MonadIO m, IsAutomationSession o) => o -> m AutomationSession

Cast to AutomationSession, for types for which this is known to be safe. For general casts, use castTo.

noAutomationSession :: Maybe AutomationSession

A convenience alias for Nothing :: Maybe AutomationSession.

Methods

getApplicationInfo

automationSessionGetApplicationInfo

Arguments

:: (HasCallStack, MonadIO m, IsAutomationSession a)

=> a

session: a AutomationSession

-> m (Maybe ApplicationInfo)

Returns: the AutomationSession of session, or Nothing if no one has been set.

Get the AutomationSession previously set with automationSessionSetApplicationInfo.

Since: 2.18

getId

automationSessionGetId

Arguments

:: (HasCallStack, MonadIO m, IsAutomationSession a)

=> a

session: a AutomationSession

-> m Text

Returns: the unique identifier of session

Get the unique identifier of a AutomationSession

Since: 2.18

setApplicationInfo

automationSessionSetApplicationInfo

Arguments

:: (HasCallStack, MonadIO m, IsAutomationSession a)

=> a

session: a AutomationSession

-> ApplicationInfo

info: a ApplicationInfo

-> m ()

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.

Since: 2.18

Properties

id

The session unique identifier.

Since: 2.18

constructAutomationSessionId :: IsAutomationSession o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “id” property. This is rarely needed directly, but it is used by new.

getAutomationSessionId :: (MonadIO m, IsAutomationSession o) => o -> m Text

Get the value of the “id” property. When overloading is enabled, this is equivalent to

get automationSession #id

Signals

createWebView

type AutomationSessionCreateWebViewCallback

Arguments

 = IO WebView

Returns: a WebView widget.

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. The returned WebView could be an existing web view or a new one created and added to a new tab or window.

Since: 2.18

type C_AutomationSessionCreateWebViewCallback = Ptr () -> Ptr () -> IO (Ptr WebView)

Type for the callback on the (unwrapped) C side.

afterAutomationSessionCreateWebView :: (IsAutomationSession a, MonadIO m) => a -> AutomationSessionCreateWebViewCallback -> m SignalHandlerId

Connect a signal handler for the “create-web-view” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after automationSession #createWebView callback

genClosure_AutomationSessionCreateWebView :: MonadIO m => AutomationSessionCreateWebViewCallback -> m (GClosure C_AutomationSessionCreateWebViewCallback)

Wrap the callback into a GClosure.

mk_AutomationSessionCreateWebViewCallback :: C_AutomationSessionCreateWebViewCallback -> IO (FunPtr C_AutomationSessionCreateWebViewCallback)

Generate a function pointer callable from C code, from a C_AutomationSessionCreateWebViewCallback.

noAutomationSessionCreateWebViewCallback :: Maybe AutomationSessionCreateWebViewCallback

A convenience synonym for Nothing :: Maybe AutomationSessionCreateWebViewCallback.

onAutomationSessionCreateWebView :: (IsAutomationSession a, MonadIO m) => a -> AutomationSessionCreateWebViewCallback -> m SignalHandlerId

Connect a signal handler for the “create-web-view” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on automationSession #createWebView callback

wrap_AutomationSessionCreateWebViewCallback :: AutomationSessionCreateWebViewCallback -> C_AutomationSessionCreateWebViewCallback

Wrap a AutomationSessionCreateWebViewCallback into a C_AutomationSessionCreateWebViewCallback.