Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.WebKit.Structs.ScriptMessageReply

Contents

Exported types
Methods

Description

A reply for a script message received. If no reply has been sent by the user, an automatically generated reply with undefined value with be sent.

Since: 2.40

Synopsis

newtype ScriptMessageReply = ScriptMessageReply (ManagedPtr ScriptMessageReply)
scriptMessageReplyRef :: (HasCallStack, MonadIO m) => ScriptMessageReply -> m ScriptMessageReply
scriptMessageReplyReturnErrorMessage :: (HasCallStack, MonadIO m) => ScriptMessageReply -> Text -> m ()
scriptMessageReplyReturnValue :: (HasCallStack, MonadIO m, IsValue a) => ScriptMessageReply -> a -> m ()
scriptMessageReplyUnref :: (HasCallStack, MonadIO m) => ScriptMessageReply -> m ()

Exported types

newtype ScriptMessageReply Source #

Memory-managed wrapper type.

Constructors

ScriptMessageReply (ManagedPtr ScriptMessageReply)

Instances

Instances details

Eq ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply Methods (==) :: ScriptMessageReply -> ScriptMessageReply -> Bool # (/=) :: ScriptMessageReply -> ScriptMessageReply -> Bool #
GBoxed ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply
ManagedPtrNewtype ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply Methods toManagedPtr :: ScriptMessageReply -> ManagedPtr ScriptMessageReply
TypedObject ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply Methods glibType :: IO GType
HasParentTypes ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply
IsGValue (Maybe ScriptMessageReply) Source #	Convert `ScriptMessageReply` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ScriptMessageReply -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ScriptMessageReply)
type ParentTypes ScriptMessageReply Source #
Instance details Defined in GI.WebKit.Structs.ScriptMessageReply type ParentTypes ScriptMessageReply = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, returnErrorMessage, returnValue, unref.

Getters

None.

Setters

None.

ref

scriptMessageReplyRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ScriptMessageReply	`scriptMessageReply`: A `ScriptMessageReply`
-> m ScriptMessageReply	Returns: the `scriptMessageReply` passed in.

Atomically increments the reference count of scriptMessageReply by one.

Since: 2.40

returnErrorMessage

scriptMessageReplyReturnErrorMessage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ScriptMessageReply	`scriptMessageReply`: A `ScriptMessageReply`
-> Text	`errorMessage`: An error message to return as specified by the user's script message
-> m ()

Reply to a script message with an error message.

Since: 2.40

returnValue

scriptMessageReplyReturnValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsValue a)
=> ScriptMessageReply	`scriptMessageReply`: A `ScriptMessageReply`
-> a	`replyValue`: Reply value of the provided script message
-> m ()

Reply to a script message with a value.

This function can be called twice for passing the reply value in.

Since: 2.40

unref

scriptMessageReplyUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ScriptMessageReply	`scriptMessageReply`: A `ScriptMessageReply`
-> m ()

Atomically decrements the reference count of scriptMessageReply by one.

If the reference count drops to 0, all the memory allocated by the ScriptMessageReply is released. This function is MT-safe and may be called from any thread.

Since: 2.40