GI.Gio.Objects.DBusObjectSkeleton

A DBusObjectSkeleton instance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic and change at runtime.

This type is intended to be used with DBusObjectManager.

Since: 2.30

Exported types

newtype DBusObjectSkeleton

Memory-managed wrapper type.

Constructors

DBusObjectSkeleton (ManagedPtr DBusObjectSkeleton)

Instances

Eq DBusObjectSkeleton

Defined in GI.Gio.Objects.DBusObjectSkeleton

Methods

(==) :: DBusObjectSkeleton -> DBusObjectSkeleton -> Bool

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

GObject DBusObjectSkeleton

Defined in GI.Gio.Objects.DBusObjectSkeleton

Methods

gobjectType :: IO GType

IsGValue DBusObjectSkeleton

Convert DBusObjectSkeleton to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.DBusObjectSkeleton

Methods

toGValue :: DBusObjectSkeleton -> IO GValue

fromGValue :: GValue -> IO DBusObjectSkeleton

HasParentTypes DBusObjectSkeleton

Defined in GI.Gio.Objects.DBusObjectSkeleton

type ParentTypes DBusObjectSkeleton

Defined in GI.Gio.Objects.DBusObjectSkeleton

type ParentTypes DBusObjectSkeleton = '[Object, DBusObject]

class (GObject o, IsDescendantOf DBusObjectSkeleton o) => IsDBusObjectSkeleton o

Type class for types which can be safely cast to DBusObjectSkeleton, for instance with toDBusObjectSkeleton.

Instances

(GObject o, IsDescendantOf DBusObjectSkeleton o) => IsDBusObjectSkeleton o

Defined in GI.Gio.Objects.DBusObjectSkeleton

toDBusObjectSkeleton :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m DBusObjectSkeleton

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

noDBusObjectSkeleton :: Maybe DBusObjectSkeleton

A convenience alias for Nothing :: Maybe DBusObjectSkeleton.

Methods

Overloaded methods

addInterface

dBusObjectSkeletonAddInterface

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b)

=> a

object: A DBusObjectSkeleton.

-> b

interface_: A DBusInterfaceSkeleton.

-> m ()

Adds interface_ to object.

If object already contains a DBusInterfaceSkeleton with the same interface name, it is removed before interface_ is added.

Note that object takes its own reference on interface_ and holds it until removed.

Since: 2.30

flush

dBusObjectSkeletonFlush

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a)

=> a

object: A DBusObjectSkeleton.

-> m ()

This method simply calls dBusInterfaceSkeletonFlush on all interfaces belonging to object. See that method for when flushing is useful.

Since: 2.30

new

dBusObjectSkeletonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

objectPath: An object path.

-> m DBusObjectSkeleton

Returns: A DBusObjectSkeleton. Free with objectUnref.

Creates a new DBusObjectSkeleton.

Since: 2.30

removeInterface

dBusObjectSkeletonRemoveInterface

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a, IsDBusInterfaceSkeleton b)

=> a

object: A DBusObjectSkeleton.

-> b

interface_: A DBusInterfaceSkeleton.

-> m ()

Removes interface_ from object.

Since: 2.30

removeInterfaceByName

dBusObjectSkeletonRemoveInterfaceByName

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a)

=> a

object: A DBusObjectSkeleton.

-> Text

interfaceName: A D-Bus interface name.

-> m ()

Removes the DBusInterface with interfaceName from object.

If no D-Bus interface of the given interface exists, this function does nothing.

Since: 2.30

setObjectPath

dBusObjectSkeletonSetObjectPath

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectSkeleton a)

=> a

object: A DBusObjectSkeleton.

-> Text

objectPath: A valid D-Bus object path.

-> m ()

Sets the object path for object.

Since: 2.30

Properties

gObjectPath

The object path where the object is exported.

Since: 2.30

clearDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m ()

Set the value of the “g-object-path” property to Nothing. When overloading is enabled, this is equivalent to

clear #gObjectPath

constructDBusObjectSkeletonGObjectPath :: IsDBusObjectSkeleton o => Text -> IO (GValueConstruct o)

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

getDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> m (Maybe Text)

Get the value of the “g-object-path” property. When overloading is enabled, this is equivalent to

get dBusObjectSkeleton #gObjectPath

setDBusObjectSkeletonGObjectPath :: (MonadIO m, IsDBusObjectSkeleton o) => o -> Text -> m ()

Set the value of the “g-object-path” property. When overloading is enabled, this is equivalent to

set dBusObjectSkeleton [ #gObjectPath := value ]

Signals

authorizeMethod

type C_DBusObjectSkeletonAuthorizeMethodCallback = Ptr () -> Ptr DBusInterfaceSkeleton -> Ptr DBusMethodInvocation -> Ptr () -> IO CInt

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

type DBusObjectSkeletonAuthorizeMethodCallback

Arguments

 = DBusInterfaceSkeleton

interface: The DBusInterfaceSkeleton that invocation is for.

-> DBusMethodInvocation

invocation: A DBusMethodInvocation.

-> IO Bool

Returns: True if the call is authorized, False otherwise.

Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized.

This signal is like DBusInterfaceSkeleton's gAuthorizeMethod signal, except that it is for the enclosing object.

The default class handler just returns True.

Since: 2.30

afterDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> DBusObjectSkeletonAuthorizeMethodCallback -> m SignalHandlerId

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

after dBusObjectSkeleton #authorizeMethod callback

genClosure_DBusObjectSkeletonAuthorizeMethod :: MonadIO m => DBusObjectSkeletonAuthorizeMethodCallback -> m (GClosure C_DBusObjectSkeletonAuthorizeMethodCallback)

Wrap the callback into a GClosure.

mk_DBusObjectSkeletonAuthorizeMethodCallback :: C_DBusObjectSkeletonAuthorizeMethodCallback -> IO (FunPtr C_DBusObjectSkeletonAuthorizeMethodCallback)

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

noDBusObjectSkeletonAuthorizeMethodCallback :: Maybe DBusObjectSkeletonAuthorizeMethodCallback

A convenience synonym for Nothing :: Maybe DBusObjectSkeletonAuthorizeMethodCallback.

onDBusObjectSkeletonAuthorizeMethod :: (IsDBusObjectSkeleton a, MonadIO m) => a -> DBusObjectSkeletonAuthorizeMethodCallback -> m SignalHandlerId

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

on dBusObjectSkeleton #authorizeMethod callback

wrap_DBusObjectSkeletonAuthorizeMethodCallback :: DBusObjectSkeletonAuthorizeMethodCallback -> C_DBusObjectSkeletonAuthorizeMethodCallback

Wrap a DBusObjectSkeletonAuthorizeMethodCallback into a C_DBusObjectSkeletonAuthorizeMethodCallback.