GI.WebKit2.Objects.AutomationSession

No description available in the introspection data.

Exported types

newtype AutomationSession

Memory-managed wrapper type.

Constructors

AutomationSession (ManagedPtr AutomationSession)

Instances

Eq AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

Methods

(==) :: AutomationSession -> AutomationSession -> Bool

(/=) :: AutomationSession -> AutomationSession -> Bool

GObject AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

ManagedPtrNewtype AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

Methods

toManagedPtr :: AutomationSession -> ManagedPtr AutomationSession

TypedObject AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

Methods

glibType :: IO GType

HasParentTypes AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

IsGValue (Maybe AutomationSession)

Convert AutomationSession to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Objects.AutomationSession

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe AutomationSession -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe AutomationSession)

type ParentTypes AutomationSession

Defined in GI.WebKit2.Objects.AutomationSession

type ParentTypes AutomationSession = '[Object]

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.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getApplicationInfo, getData, getId, getProperty, getQdata.

Setters

setApplicationInfo, setData, setDataFull, setProperty.

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 automationStarted signal.

Since: 2.18

Properties

id

The session unique identifier.

Since: 2.18

constructAutomationSessionId :: (IsAutomationSession o, MonadIO m) => Text -> m (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 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.

Since: 2.18

afterAutomationSessionCreateWebView :: (IsAutomationSession a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => AutomationSessionCreateWebViewCallback) -> m SignalHandlerId

Connect a signal handler for the createWebView signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after automationSession #createWebView callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “create-web-view::detail” instead.

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onAutomationSessionCreateWebView :: (IsAutomationSession a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => AutomationSessionCreateWebViewCallback) -> m SignalHandlerId

Connect a signal handler for the createWebView signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on automationSession #createWebView callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “create-web-view::detail” instead.