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

GI.Gio.Objects.DBusMessage

Contents

Exported types
Methods
Properties
- locked

Description

A type for representing D-Bus messages that can be sent or received on a DBusConnection.

Since: 2.26

Synopsis

newtype DBusMessage = DBusMessage (ManagedPtr DBusMessage)
class (GObject o, IsDescendantOf DBusMessage o) => IsDBusMessage o
toDBusMessage :: (MonadIO m, IsDBusMessage o) => o -> m DBusMessage
type family ResolveDBusMessageMethod (t :: Symbol) o where ...
dBusMessageBytesNeeded :: (HasCallStack, MonadIO m) => ByteString -> m Int64
data DBusMessageCopyMethodInfo
dBusMessageCopy :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m DBusMessage
data DBusMessageGetArg0MethodInfo
dBusMessageGetArg0 :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetArg0PathMethodInfo
dBusMessageGetArg0Path :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetBodyMethodInfo
dBusMessageGetBody :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe GVariant)
data DBusMessageGetByteOrderMethodInfo
dBusMessageGetByteOrder :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m DBusMessageByteOrder
data DBusMessageGetDestinationMethodInfo
dBusMessageGetDestination :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetErrorNameMethodInfo
dBusMessageGetErrorName :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetFlagsMethodInfo
dBusMessageGetFlags :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m [DBusMessageFlags]
data DBusMessageGetHeaderMethodInfo
dBusMessageGetHeader :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> DBusMessageHeaderField -> m (Maybe GVariant)
data DBusMessageGetHeaderFieldsMethodInfo
dBusMessageGetHeaderFields :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m ByteString
data DBusMessageGetInterfaceMethodInfo
dBusMessageGetInterface :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetLockedMethodInfo
dBusMessageGetLocked :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m Bool
data DBusMessageGetMemberMethodInfo
dBusMessageGetMember :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetMessageTypeMethodInfo
dBusMessageGetMessageType :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m DBusMessageType
data DBusMessageGetNumUnixFdsMethodInfo
dBusMessageGetNumUnixFds :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m Word32
data DBusMessageGetPathMethodInfo
dBusMessageGetPath :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetReplySerialMethodInfo
dBusMessageGetReplySerial :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m Word32
data DBusMessageGetSenderMethodInfo
dBusMessageGetSender :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe Text)
data DBusMessageGetSerialMethodInfo
dBusMessageGetSerial :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m Word32
data DBusMessageGetSignatureMethodInfo
dBusMessageGetSignature :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m Text
data DBusMessageGetUnixFdListMethodInfo
dBusMessageGetUnixFdList :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m (Maybe UnixFDList)
data DBusMessageLockMethodInfo
dBusMessageLock :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m ()
dBusMessageNew :: (HasCallStack, MonadIO m) => m DBusMessage
dBusMessageNewFromBlob :: (HasCallStack, MonadIO m) => ByteString -> [DBusCapabilityFlags] -> m DBusMessage
dBusMessageNewMethodCall :: (HasCallStack, MonadIO m) => Maybe Text -> Text -> Maybe Text -> Text -> m DBusMessage
data DBusMessageNewMethodErrorLiteralMethodInfo
dBusMessageNewMethodErrorLiteral :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Text -> Text -> m DBusMessage
data DBusMessageNewMethodReplyMethodInfo
dBusMessageNewMethodReply :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m DBusMessage
dBusMessageNewSignal :: (HasCallStack, MonadIO m) => Text -> Text -> Text -> m DBusMessage
data DBusMessagePrintMethodInfo
dBusMessagePrint :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Word32 -> m Text
data DBusMessageSetBodyMethodInfo
dBusMessageSetBody :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> GVariant -> m ()
data DBusMessageSetByteOrderMethodInfo
dBusMessageSetByteOrder :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> DBusMessageByteOrder -> m ()
data DBusMessageSetDestinationMethodInfo
dBusMessageSetDestination :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetErrorNameMethodInfo
dBusMessageSetErrorName :: (HasCallStack, MonadIO m, IsDBusMessage a) => Maybe a -> Text -> m ()
data DBusMessageSetFlagsMethodInfo
dBusMessageSetFlags :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> [DBusMessageFlags] -> m ()
data DBusMessageSetHeaderMethodInfo
dBusMessageSetHeader :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> DBusMessageHeaderField -> Maybe GVariant -> m ()
data DBusMessageSetInterfaceMethodInfo
dBusMessageSetInterface :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetMemberMethodInfo
dBusMessageSetMember :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetMessageTypeMethodInfo
dBusMessageSetMessageType :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> DBusMessageType -> m ()
data DBusMessageSetNumUnixFdsMethodInfo
dBusMessageSetNumUnixFds :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Word32 -> m ()
data DBusMessageSetPathMethodInfo
dBusMessageSetPath :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetReplySerialMethodInfo
dBusMessageSetReplySerial :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Word32 -> m ()
data DBusMessageSetSenderMethodInfo
dBusMessageSetSender :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetSerialMethodInfo
dBusMessageSetSerial :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Word32 -> m ()
data DBusMessageSetSignatureMethodInfo
dBusMessageSetSignature :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> Maybe Text -> m ()
data DBusMessageSetUnixFdListMethodInfo
dBusMessageSetUnixFdList :: (HasCallStack, MonadIO m, IsDBusMessage a, IsUnixFDList b) => a -> Maybe b -> m ()
data DBusMessageToBlobMethodInfo
dBusMessageToBlob :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> [DBusCapabilityFlags] -> m ByteString
data DBusMessageToGerrorMethodInfo
dBusMessageToGerror :: (HasCallStack, MonadIO m, IsDBusMessage a) => a -> m ()
data DBusMessageLockedPropertyInfo
dBusMessageLocked :: AttrLabelProxy "locked"
getDBusMessageLocked :: (MonadIO m, IsDBusMessage o) => o -> m Bool

Exported types

newtype DBusMessage Source #

Memory-managed wrapper type.

Constructors

DBusMessage (ManagedPtr DBusMessage)

Instances

Instances details

Eq DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods (==) :: DBusMessage -> DBusMessage -> Bool # (/=) :: DBusMessage -> DBusMessage -> Bool #
GObject DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage
ManagedPtrNewtype DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods toManagedPtr :: DBusMessage -> ManagedPtr DBusMessage #
TypedObject DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods glibType :: IO GType #
HasParentTypes DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage
HasAttributeList DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage
(info ~ ResolveDBusMessageMethod t DBusMessage, OverloadedMethod info DBusMessage p, HasField t DBusMessage p) => HasField (t :: Symbol) DBusMessage (p :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods getField :: DBusMessage -> p #
(info ~ ResolveDBusMessageMethod t DBusMessage, OverloadedMethodInfo info DBusMessage) => IsLabel t (MethodProxy info DBusMessage) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods fromLabel :: MethodProxy info DBusMessage #
(info ~ ResolveDBusMessageMethod t DBusMessage, OverloadedMethod info DBusMessage p) => IsLabel t (DBusMessage -> p) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods fromLabel :: DBusMessage -> p #
IsGValue (Maybe DBusMessage) Source #	Convert `DBusMessage` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Objects.DBusMessage Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe DBusMessage -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe DBusMessage) #
type AttributeList DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage type AttributeList DBusMessage
type ParentTypes DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage type ParentTypes DBusMessage = '[Object]
type SignalList DBusMessage Source #
Instance details Defined in GI.Gio.Objects.DBusMessage type SignalList DBusMessage

class (GObject o, IsDescendantOf DBusMessage o) => IsDBusMessage o Source #

Type class for types which can be safely cast to DBusMessage, for instance with toDBusMessage.

Instances

Instances details

(GObject o, IsDescendantOf DBusMessage o) => IsDBusMessage o Source #
Instance details Defined in GI.Gio.Objects.DBusMessage

toDBusMessage :: (MonadIO m, IsDBusMessage o) => o -> m DBusMessage Source #

Cast to DBusMessage, 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

Expand

Equations

ResolveDBusMessageMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveDBusMessageMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveDBusMessageMethod "copy" o = DBusMessageCopyMethodInfo
ResolveDBusMessageMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveDBusMessageMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveDBusMessageMethod "getv" o = ObjectGetvMethodInfo
ResolveDBusMessageMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveDBusMessageMethod "lock" o = DBusMessageLockMethodInfo
ResolveDBusMessageMethod "newMethodErrorLiteral" o = DBusMessageNewMethodErrorLiteralMethodInfo
ResolveDBusMessageMethod "newMethodReply" o = DBusMessageNewMethodReplyMethodInfo
ResolveDBusMessageMethod "notify" o = ObjectNotifyMethodInfo
ResolveDBusMessageMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveDBusMessageMethod "print" o = DBusMessagePrintMethodInfo
ResolveDBusMessageMethod "ref" o = ObjectRefMethodInfo
ResolveDBusMessageMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveDBusMessageMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveDBusMessageMethod "stealData" o = ObjectStealDataMethodInfo
ResolveDBusMessageMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveDBusMessageMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveDBusMessageMethod "toBlob" o = DBusMessageToBlobMethodInfo
ResolveDBusMessageMethod "toGerror" o = DBusMessageToGerrorMethodInfo
ResolveDBusMessageMethod "unref" o = ObjectUnrefMethodInfo
ResolveDBusMessageMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveDBusMessageMethod "getArg0" o = DBusMessageGetArg0MethodInfo
ResolveDBusMessageMethod "getArg0Path" o = DBusMessageGetArg0PathMethodInfo
ResolveDBusMessageMethod "getBody" o = DBusMessageGetBodyMethodInfo
ResolveDBusMessageMethod "getByteOrder" o = DBusMessageGetByteOrderMethodInfo
ResolveDBusMessageMethod "getData" o = ObjectGetDataMethodInfo
ResolveDBusMessageMethod "getDestination" o = DBusMessageGetDestinationMethodInfo
ResolveDBusMessageMethod "getErrorName" o = DBusMessageGetErrorNameMethodInfo
ResolveDBusMessageMethod "getFlags" o = DBusMessageGetFlagsMethodInfo
ResolveDBusMessageMethod "getHeader" o = DBusMessageGetHeaderMethodInfo
ResolveDBusMessageMethod "getHeaderFields" o = DBusMessageGetHeaderFieldsMethodInfo
ResolveDBusMessageMethod "getInterface" o = DBusMessageGetInterfaceMethodInfo
ResolveDBusMessageMethod "getLocked" o = DBusMessageGetLockedMethodInfo
ResolveDBusMessageMethod "getMember" o = DBusMessageGetMemberMethodInfo
ResolveDBusMessageMethod "getMessageType" o = DBusMessageGetMessageTypeMethodInfo
ResolveDBusMessageMethod "getNumUnixFds" o = DBusMessageGetNumUnixFdsMethodInfo
ResolveDBusMessageMethod "getPath" o = DBusMessageGetPathMethodInfo
ResolveDBusMessageMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveDBusMessageMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveDBusMessageMethod "getReplySerial" o = DBusMessageGetReplySerialMethodInfo
ResolveDBusMessageMethod "getSender" o = DBusMessageGetSenderMethodInfo
ResolveDBusMessageMethod "getSerial" o = DBusMessageGetSerialMethodInfo
ResolveDBusMessageMethod "getSignature" o = DBusMessageGetSignatureMethodInfo
ResolveDBusMessageMethod "getUnixFdList" o = DBusMessageGetUnixFdListMethodInfo
ResolveDBusMessageMethod "setBody" o = DBusMessageSetBodyMethodInfo
ResolveDBusMessageMethod "setByteOrder" o = DBusMessageSetByteOrderMethodInfo
ResolveDBusMessageMethod "setData" o = ObjectSetDataMethodInfo
ResolveDBusMessageMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveDBusMessageMethod "setDestination" o = DBusMessageSetDestinationMethodInfo
ResolveDBusMessageMethod "setErrorName" o = DBusMessageSetErrorNameMethodInfo
ResolveDBusMessageMethod "setFlags" o = DBusMessageSetFlagsMethodInfo
ResolveDBusMessageMethod "setHeader" o = DBusMessageSetHeaderMethodInfo
ResolveDBusMessageMethod "setInterface" o = DBusMessageSetInterfaceMethodInfo
ResolveDBusMessageMethod "setMember" o = DBusMessageSetMemberMethodInfo
ResolveDBusMessageMethod "setMessageType" o = DBusMessageSetMessageTypeMethodInfo
ResolveDBusMessageMethod "setNumUnixFds" o = DBusMessageSetNumUnixFdsMethodInfo
ResolveDBusMessageMethod "setPath" o = DBusMessageSetPathMethodInfo
ResolveDBusMessageMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveDBusMessageMethod "setReplySerial" o = DBusMessageSetReplySerialMethodInfo
ResolveDBusMessageMethod "setSender" o = DBusMessageSetSenderMethodInfo
ResolveDBusMessageMethod "setSerial" o = DBusMessageSetSerialMethodInfo
ResolveDBusMessageMethod "setSignature" o = DBusMessageSetSignatureMethodInfo
ResolveDBusMessageMethod "setUnixFdList" o = DBusMessageSetUnixFdListMethodInfo
ResolveDBusMessageMethod l o = MethodResolutionFailed l o :: Type

bytesNeeded

dBusMessageBytesNeeded Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteString	`blob`: A blob representing a binary D-Bus message.
-> m Int64	Returns: Number of bytes needed or -1 if `error` is set (e.g. if `blob` contains invalid data or not enough data is available to determine the size). (Can throw `GError`)

Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob.

Since: 2.26

copy

data DBusMessageCopyMethodInfo Source #

Instances

Instances details

(signature ~ m DBusMessage, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageCopyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageCopyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageCopy Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m DBusMessage	Returns: A new `DBusMessage` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

Copies message. The copy is a deep copy and the returned DBusMessage is completely identical except that it is guaranteed to not be locked.

This operation can fail if e.g. message contains file descriptors and the per-process or system-wide open files limit is reached.

Since: 2.26

getArg0

data DBusMessageGetArg0MethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetArg0MethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetArg0MethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetArg0 Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The string item or `Nothing` if the first item in the body of `message` is not a string.

Convenience to get the first item in the body of message.

See dBusMessageGetArg0Path for returning object-path-typed arg0 values.

Since: 2.26

getArg0Path

data DBusMessageGetArg0PathMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetArg0PathMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetArg0PathMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetArg0Path Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `GDBusMessage`.
-> m (Maybe Text)	Returns: The object path item or `NULL` if the first item in the body of `message` is not an object path.

Convenience to get the first item in the body of message.

See dBusMessageGetArg0 for returning string-typed arg0 values.

Since: 2.80

getDestination

data DBusMessageGetDestinationMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetDestinationMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetDestinationMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetDestination Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldDestination header field.

Since: 2.26

getErrorName

data DBusMessageGetErrorNameMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetErrorNameMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetErrorNameMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetErrorName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldErrorName header field.

Since: 2.26

getFlags

data DBusMessageGetFlagsMethodInfo Source #

Instances

Instances details

(signature ~ m [DBusMessageFlags], MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetFlagsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetFlagsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m [DBusMessageFlags]	Returns: Flags that are set (typically values from the `DBusMessageFlags` enumeration bitwise ORed together).

Gets the flags for message.

Since: 2.26

getHeader

data DBusMessageGetHeaderMethodInfo Source #

Instances

Instances details

(signature ~ (DBusMessageHeaderField -> m (Maybe GVariant)), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetHeaderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetHeaderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetHeader Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageHeaderField	`headerField`: A 8-bit unsigned integer (typically a value from the `DBusMessageHeaderField` enumeration)
-> m (Maybe GVariant)	Returns: A `GVariant` with the value if the header was found, `Nothing` otherwise. Do not free, it is owned by `message`.

Gets a header field on message.

The caller is responsible for checking the type of the returned GVariant matches what is expected.

Since: 2.26

getHeaderFields

data DBusMessageGetHeaderFieldsMethodInfo Source #

Instances

Instances details

(signature ~ m ByteString, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetHeaderFieldsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetHeaderFieldsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetHeaderFields Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ByteString	Returns: An array of header fields terminated by `DBusMessageHeaderFieldInvalid`. Each element is a `guchar`. Free with `free`.

Gets an array of all header fields on message that are set.

Since: 2.26

getInterface

data DBusMessageGetInterfaceMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetInterfaceMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetInterfaceMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldInterface header field.

Since: 2.26

getLocked

data DBusMessageGetLockedMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetLockedMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetLockedMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetLocked Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Bool	Returns: `True` if `message` is locked, `False` otherwise.

Checks whether message is locked. To monitor changes to this value, conncet to the Object::notify signal to listen for changes on the DBusMessage:locked property.

Since: 2.26

getMember

data DBusMessageGetMemberMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetMemberMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetMemberMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetMember Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldMember header field.

Since: 2.26

getMessageType

data DBusMessageGetMessageTypeMethodInfo Source #

Instances

Instances details

(signature ~ m DBusMessageType, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetMessageTypeMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetMessageTypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetMessageType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m DBusMessageType	Returns: A 8-bit unsigned integer (typically a value from the `DBusMessageType` enumeration).

Gets the type of message.

Since: 2.26

getNumUnixFds

data DBusMessageGetNumUnixFdsMethodInfo Source #

Instances

Instances details

(signature ~ m Word32, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetNumUnixFdsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetNumUnixFdsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetNumUnixFds Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldNumUnixFds header field.

Since: 2.26

getPath

data DBusMessageGetPathMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetPathMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetPathMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldPath header field.

Since: 2.26

getReplySerial

data DBusMessageGetReplySerialMethodInfo Source #

Instances

Instances details

(signature ~ m Word32, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetReplySerialMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetReplySerialMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetReplySerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldReplySerial header field.

Since: 2.26

getSender

data DBusMessageGetSenderMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetSenderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetSenderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetSender Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe Text)	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldSender header field.

Since: 2.26

getSerial

data DBusMessageGetSerialMethodInfo Source #

Instances

Instances details

(signature ~ m Word32, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetSerialMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetSerialMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetSerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: A `guint32`.

Gets the serial for message.

Since: 2.26

getSignature

data DBusMessageGetSignatureMethodInfo Source #

Instances

Instances details

(signature ~ m Text, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetSignatureMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetSignatureMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetSignature Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldSignature header field.

This will always be non-Nothing, but may be an empty string.

Since: 2.26

getUnixFdList

data DBusMessageGetUnixFdListMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe UnixFDList), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetUnixFdListMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetUnixFdListMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageGetUnixFdList Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m (Maybe UnixFDList)	Returns: A `UnixFDList` or `Nothing` if no file descriptors are associated. Do not free, this object is owned by `message`.

Gets the UNIX file descriptors associated with message, if any.

This method is only available on UNIX.

The file descriptors normally correspond to G_VARIANT_TYPE_HANDLE values in the body of the message. For example, if variantGetHandle returns 5, that is intended to be a reference to the file descriptor that can be accessed by g_unix_fd_list_get (list, 5, ...).

Since: 2.26

lock

data DBusMessageLockMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageLockMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageLockMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageLock Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ()

If message is locked, does nothing. Otherwise locks the message.

Since: 2.26

new

dBusMessageNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new empty DBusMessage.

Since: 2.26

newFromBlob

dBusMessageNewFromBlob Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteString	`blob`: A blob representing a binary D-Bus message.
-> [DBusCapabilityFlags]	`capabilities`: A `DBusCapabilityFlags` describing what protocol features are supported.
-> m DBusMessage	Returns: A new `DBusMessage` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

Creates a new DBusMessage from the data stored at blob. The byte order that the message was in can be retrieved using dBusMessageGetByteOrder.

If the blob cannot be parsed, contains invalid fields, or contains invalid headers, IOErrorEnumInvalidArgument will be returned.

Since: 2.26

newMethodCall

dBusMessageNewMethodCall Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Maybe Text	`name`: A valid D-Bus name or `Nothing`.
-> Text	`path`: A valid object path.
-> Maybe Text	`interface_`: A valid D-Bus interface name or `Nothing`.
-> Text	`method`: A valid method name.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage for a method call.

Since: 2.26

newMethodErrorLiteral

data DBusMessageNewMethodErrorLiteralMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Text -> m DBusMessage), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageNewMethodErrorLiteralMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageNewMethodErrorLiteralMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageNewMethodErrorLiteral Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`methodCallMessage`: A message of type `DBusMessageTypeMethodCall` to create a reply message to.
-> Text	`errorName`: A valid D-Bus error name.
-> Text	`errorMessage`: The D-Bus error message.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage that is an error reply to methodCallMessage.

Since: 2.26

newMethodReply

data DBusMessageNewMethodReplyMethodInfo Source #

Instances

Instances details

(signature ~ m DBusMessage, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageNewMethodReplyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageNewMethodReplyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageNewMethodReply Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`methodCallMessage`: A message of type `DBusMessageTypeMethodCall` to create a reply message to.
-> m DBusMessage	Returns: `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage that is a reply to methodCallMessage.

Since: 2.26

newSignal

dBusMessageNewSignal Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`path`: A valid object path.
-> Text	`interface_`: A valid D-Bus interface name.
-> Text	`signal`: A valid signal name.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage for a signal emission.

Since: 2.26

print

data DBusMessagePrintMethodInfo Source #

Instances

Instances details

(signature ~ (Word32 -> m Text), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessagePrintMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessagePrintMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessagePrint Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`indent`: Indentation level.
-> m Text	Returns: A string that should be freed with `free`.

Produces a human-readable multi-line description of message.

The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output looks something like this:

Flags:   none
Version: 0
Serial:  4
Headers:
  path -> objectpath '/org/gtk/GDBus/TestObject'
  interface -> 'org.gtk.GDBus.TestInterface'
  member -> 'GimmeStdout'
  destination -> ':1.146'
Body: ()
UNIX File Descriptors:
  (none)

or

Flags:   no-reply-expected
Version: 0
Serial:  477
Headers:
  reply-serial -> uint32 4
  destination -> ':1.159'
  sender -> ':1.146'
  num-unix-fds -> uint32 1
Body: ()
UNIX File Descriptors:
  fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635

Since: 2.26

setBody

data DBusMessageSetBodyMethodInfo Source #

Instances

Instances details

(signature ~ (GVariant -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetBodyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetBodyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetBody Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> GVariant	`body`: Either `Nothing` or a `GVariant` that is a tuple.
-> m ()

Sets the body message. As a side-effect the DBusMessageHeaderFieldSignature header field is set to the type string of body (or cleared if body is Nothing).

If body is floating, message assumes ownership of body.

Since: 2.26

setByteOrder

data DBusMessageSetByteOrderMethodInfo Source #

Instances

Instances details

(signature ~ (DBusMessageByteOrder -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetByteOrderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetByteOrderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetByteOrder Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageByteOrder	`byteOrder`: The byte order.
-> m ()

Sets the byte order of message.

setDestination

data DBusMessageSetDestinationMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetDestinationMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetDestinationMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetDestination Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldDestination header field.

Since: 2.26

setErrorName

data DBusMessageSetErrorNameMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetErrorNameMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetErrorNameMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetErrorName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> Maybe a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldErrorName header field.

Since: 2.26

setFlags

data DBusMessageSetFlagsMethodInfo Source #

Instances

Instances details

(signature ~ ([DBusMessageFlags] -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetFlagsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetFlagsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> [DBusMessageFlags]	`flags`: Flags for `message` that are set (typically values from the `DBusMessageFlags` enumeration bitwise ORed together).
-> m ()

Sets the flags to set on message.

Since: 2.26

setHeader

data DBusMessageSetHeaderMethodInfo Source #

Instances

Instances details

(signature ~ (DBusMessageHeaderField -> Maybe GVariant -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetHeaderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetHeaderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetHeader Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageHeaderField	`headerField`: A 8-bit unsigned integer (typically a value from the `DBusMessageHeaderField` enumeration)
-> Maybe GVariant	`value`: A `GVariant` to set the header field or `Nothing` to clear the header field.
-> m ()

Sets a header field on message.

If value is floating, message assumes ownership of value.

Since: 2.26

setInterface

data DBusMessageSetInterfaceMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetInterfaceMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetInterfaceMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldInterface header field.

Since: 2.26

setMember

data DBusMessageSetMemberMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetMemberMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetMemberMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetMember Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldMember header field.

Since: 2.26

setMessageType

data DBusMessageSetMessageTypeMethodInfo Source #

Instances

Instances details

(signature ~ (DBusMessageType -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetMessageTypeMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetMessageTypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetMessageType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageType	`type`: A 8-bit unsigned integer (typically a value from the `DBusMessageType` enumeration).
-> m ()

Sets message to be of type.

Since: 2.26

setNumUnixFds

data DBusMessageSetNumUnixFdsMethodInfo Source #

Instances

Instances details

(signature ~ (Word32 -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetNumUnixFdsMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetNumUnixFdsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetNumUnixFds Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldNumUnixFds header field.

Since: 2.26

setPath

data DBusMessageSetPathMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetPathMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetPathMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldPath header field.

Since: 2.26

setReplySerial

data DBusMessageSetReplySerialMethodInfo Source #

Instances

Instances details

(signature ~ (Word32 -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetReplySerialMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetReplySerialMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetReplySerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldReplySerial header field.

Since: 2.26

setSender

data DBusMessageSetSenderMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetSenderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetSenderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetSender Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldSender header field.

Since: 2.26

setSerial

data DBusMessageSetSerialMethodInfo Source #

Instances

Instances details

(signature ~ (Word32 -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetSerialMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetSerialMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetSerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`serial`: A `guint32`, which must not be zero.
-> m ()

Sets the serial for message.

The D-Bus specification does not allow the serial to be zero.

Since: 2.26

setSignature

data DBusMessageSetSignatureMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Text -> m ()), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageSetSignatureMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetSignatureMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetSignature Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Maybe Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldSignature header field.

Since: 2.26

setUnixFdList

data DBusMessageSetUnixFdListMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe b -> m ()), MonadIO m, IsDBusMessage a, IsUnixFDList b) => OverloadedMethod DBusMessageSetUnixFdListMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageSetUnixFdListMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageSetUnixFdList Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a, IsUnixFDList b)
=> a	`message`: A `DBusMessage`.
-> Maybe b	`fdList`: A `UnixFDList` or `Nothing`.
-> m ()

Sets the UNIX file descriptors associated with message. As a side-effect the DBusMessageHeaderFieldNumUnixFds header field is set to the number of fds in fdList (or cleared if fdList is Nothing).

This method is only available on UNIX.

When designing D-Bus APIs that are intended to be interoperable, please note that non-GDBus implementations of D-Bus can usually only access file descriptors if they are referenced by a value of type G_VARIANT_TYPE_HANDLE in the body of the message.

Since: 2.26

toBlob

data DBusMessageToBlobMethodInfo Source #

Instances

Instances details

(signature ~ ([DBusCapabilityFlags] -> m ByteString), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageToBlobMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageToBlobMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageToBlob Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> [DBusCapabilityFlags]	`capabilities`: A `DBusCapabilityFlags` describing what protocol features are supported.
-> m ByteString	Returns: A pointer to a valid binary D-Bus message of `outSize` bytes generated by `message` or `Nothing` if `error` is set. Free with `free`. (Can throw `GError`)

Serializes message to a blob. The byte order returned by dBusMessageGetByteOrder will be used.

Since: 2.26

toGerror

data DBusMessageToGerrorMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageToGerrorMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageToGerrorMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

dBusMessageToGerror Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ()	(Can throw `GError`)

If message is not of type DBusMessageTypeError does nothing and returns False.

Otherwise this method encodes the error in message as a GError using g_dbus_error_set_dbus_error() using the information in the DBusMessageHeaderFieldErrorName header field of message as well as the first string item in message's body.

Since: 2.26

Properties

locked

No description available in the introspection data.

data DBusMessageLockedPropertyInfo Source #

Instances

Instances details

AttrInfo DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

Associated Types

type AttrAllowedOps DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrAllowedOps DBusMessageLockedPropertyInfo = '['AttrGet]
type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo = IsDBusMessage
type AttrGetType DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrGetType DBusMessageLockedPropertyInfo = Bool
type AttrSetTypeConstraint DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrSetTypeConstraint DBusMessageLockedPropertyInfo = Type ~ ()
type AttrTransferTypeConstraint DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrTransferTypeConstraint DBusMessageLockedPropertyInfo = Type ~ ()
type AttrTransferType DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrTransferType DBusMessageLockedPropertyInfo = ()
type AttrLabel DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrLabel DBusMessageLockedPropertyInfo = "locked"
type AttrOrigin DBusMessageLockedPropertyInfo
Instance details Defined in GI.Gio.Objects.DBusMessage type AttrOrigin DBusMessageLockedPropertyInfo = DBusMessage

Methods

attrGet :: AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o => o -> IO (AttrGetType DBusMessageLockedPropertyInfo) #

attrSet :: (AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o, AttrSetTypeConstraint DBusMessageLockedPropertyInfo b) => o -> b -> IO () #

attrClear :: AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o => o -> IO () #

attrConstruct :: (AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o, AttrSetTypeConstraint DBusMessageLockedPropertyInfo b) => b -> IO (GValueConstruct o) #

attrTransfer :: (AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o, AttrTransferTypeConstraint DBusMessageLockedPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType DBusMessageLockedPropertyInfo) #

dbgAttrInfo :: Maybe ResolvedSymbolInfo #

type AttrAllowedOps DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrAllowedOps DBusMessageLockedPropertyInfo = '['AttrGet]

type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo = IsDBusMessage

type AttrGetType DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrGetType DBusMessageLockedPropertyInfo = Bool

type AttrLabel DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrLabel DBusMessageLockedPropertyInfo = "locked"

type AttrOrigin DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrOrigin DBusMessageLockedPropertyInfo = DBusMessage

type AttrSetTypeConstraint DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrSetTypeConstraint DBusMessageLockedPropertyInfo = Type ~ ()

type AttrTransferType DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrTransferType DBusMessageLockedPropertyInfo = ()

type AttrTransferTypeConstraint DBusMessageLockedPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.DBusMessage

type AttrTransferTypeConstraint DBusMessageLockedPropertyInfo = Type ~ ()

dBusMessageLocked :: AttrLabelProxy "locked" Source #

getDBusMessageLocked :: (MonadIO m, IsDBusMessage o) => o -> m Bool Source #

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

get dBusMessage #locked

(signature ~ m (Maybe GVariant), MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetBodyMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetBodyMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

(signature ~ m DBusMessageByteOrder, MonadIO m, IsDBusMessage a) => OverloadedMethod DBusMessageGetByteOrderMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo DBusMessageGetByteOrderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.DBusMessage Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

bytesNeeded

copy

Instances

getArg0

Instances

getArg0Path

Instances

getBody

Instances

getByteOrder

Instances

getDestination

Instances

getErrorName

Instances

getFlags

Instances

getHeader

Instances

getHeaderFields

Instances

getInterface

Instances

getLocked

Instances

getMember

Instances

getMessageType

Instances

getNumUnixFds

Instances

getPath

Instances

getReplySerial

Instances

getSender

Instances

getSerial

Instances

getSignature

Instances

getUnixFdList

Instances

lock

Instances

new

newFromBlob

newMethodCall

newMethodErrorLiteral

Instances

newMethodReply

Instances

newSignal

print

Instances

setBody

Instances

setByteOrder

Instances

setDestination

Instances

setErrorName

Instances

setFlags

Instances

setHeader

Instances

setInterface

Instances

setMember

Instances

setMessageType