EDBusAddressBookFactorySkeleton

EDBusAddressBookFactorySkeleton

Object Hierarchy

    GInterface
    ╰── EDBusAddressBookFactory
    GObject
    ├── GDBusInterfaceSkeleton
       ╰── EDBusAddressBookFactorySkeleton
    ╰── GDBusProxy
        ╰── EDBusAddressBookFactoryProxy

Prerequisites

EDBusAddressBookFactory requires GObject.

Implemented Interfaces

EDBusAddressBookFactoryProxy implements GDBusInterface, GInitable, GAsyncInitable and EDBusAddressBookFactory.

EDBusAddressBookFactorySkeleton implements GDBusInterface and EDBusAddressBookFactory.

Known Implementations

EDBusAddressBookFactory is implemented by EDBusAddressBookFactoryProxy and EDBusAddressBookFactorySkeleton.

Description

Functions

e_dbus_address_book_factory_interface_info ()

GDBusInterfaceInfo *
e_dbus_address_book_factory_interface_info
                               (void);

Gets a machine-readable description of the org.gnome.evolution.dataserver.AddressBookFactory D-Bus interface.

Returns

A GDBusInterfaceInfo. Do not free.

[transfer none]

Since: 3.8


e_dbus_address_book_factory_override_properties ()

guint
e_dbus_address_book_factory_override_properties
                               (GObjectClass *klass,
                                guint property_id_begin);

Overrides all GObject properties in the EDBusAddressBookFactory interface for a concrete class. The properties are overridden in the order they are defined.

Parameters

klass

The class structure for a GObject-derived class.

 

property_id_begin

The property id to assign to the first overridden property.

 

Returns

The last property id.

Since: 3.8


e_dbus_address_book_factory_complete_open_address_book ()

void
e_dbus_address_book_factory_complete_open_address_book
                               (EDBusAddressBookFactory *object,
                                GDBusMethodInvocation *invocation,
                                const gchar *object_path,
                                const gchar *bus_name);

Helper function used in service implementations to finish handling invocations of the OpenAddressBook() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation , you cannot use it afterwards.

Parameters

object

A EDBusAddressBookFactory.

 

invocation

A GDBusMethodInvocation.

[transfer full]

object_path

Parameter to return.

 

bus_name

Parameter to return.

 

Since: 3.8


e_dbus_address_book_factory_call_open_address_book ()

void
e_dbus_address_book_factory_call_open_address_book
                               (EDBusAddressBookFactory *proxy,
                                const gchar *arg_source_uid,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously invokes the OpenAddressBook() D-Bus method on proxy . When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call e_dbus_address_book_factory_call_open_address_book_finish() to get the result of the operation.

See e_dbus_address_book_factory_call_open_address_book_sync() for the synchronous, blocking version of this method.

Parameters

proxy

A EDBusAddressBookFactoryProxy.

 

arg_source_uid

Argument to pass with the method invocation.

 

cancellable

A GCancellable or NULL.

[allow-none]

callback

A GAsyncReadyCallback to call when the request is satisfied or NULL.

 

user_data

User data to pass to callback .

 

Since: 3.8


e_dbus_address_book_factory_call_open_address_book_finish ()

gboolean
e_dbus_address_book_factory_call_open_address_book_finish
                               (EDBusAddressBookFactory *proxy,
                                gchar **out_object_path,
                                gchar **out_bus_name,
                                GAsyncResult *res,
                                GError **error);

Finishes an operation started with e_dbus_address_book_factory_call_open_address_book().

Parameters

proxy

A EDBusAddressBookFactoryProxy.

 

out_object_path

Return location for return parameter or NULL to ignore.

[out]

out_bus_name

Return location for return parameter or NULL to ignore.

[out]

res

The GAsyncResult obtained from the GAsyncReadyCallback passed to e_dbus_address_book_factory_call_open_address_book().

 

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]

Since: 3.8


e_dbus_address_book_factory_call_open_address_book_sync ()

gboolean
e_dbus_address_book_factory_call_open_address_book_sync
                               (EDBusAddressBookFactory *proxy,
                                const gchar *arg_source_uid,
                                gchar **out_object_path,
                                gchar **out_bus_name,
                                GCancellable *cancellable,
                                GError **error);

Synchronously invokes the OpenAddressBook() D-Bus method on proxy . The calling thread is blocked until a reply is received.

See e_dbus_address_book_factory_call_open_address_book() for the asynchronous version of this method.

Parameters

proxy

A EDBusAddressBookFactoryProxy.

 

arg_source_uid

Argument to pass with the method invocation.

 

out_object_path

Return location for return parameter or NULL to ignore.

[out]

out_bus_name

Return location for return parameter or NULL to ignore.

[out]

cancellable

A GCancellable or NULL.

[allow-none]

error

Return location for error or NULL.

 

Returns

TRUE if the call succeded, FALSE if error is set.

[skip]

Since: 3.8


e_dbus_address_book_factory_proxy_new ()

void
e_dbus_address_book_factory_proxy_new (GDBusConnection *connection,
                                       GDBusProxyFlags flags,
                                       const gchar *name,
                                       const gchar *object_path,
                                       GCancellable *cancellable,
                                       GAsyncReadyCallback callback,
                                       gpointer user_data);

Asynchronously creates a proxy for the D-Bus interface org.gnome.evolution.dataserver.AddressBookFactory. See g_dbus_proxy_new() for more details.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call e_dbus_address_book_factory_proxy_new_finish() to get the result of the operation.

See e_dbus_address_book_factory_proxy_new_sync() for the synchronous, blocking version of this constructor.

Parameters

connection

A GDBusConnection.

 

flags

Flags from the GDBusProxyFlags enumeration.

 

name

A bus name (well-known or unique) or NULL if connection is not a message bus connection.

[allow-none]

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[allow-none]

callback

A GAsyncReadyCallback to call when the request is satisfied.

 

user_data

User data to pass to callback .

 

Since: 3.8


e_dbus_address_book_factory_proxy_new_finish ()

EDBusAddressBookFactory *
e_dbus_address_book_factory_proxy_new_finish
                               (GAsyncResult *res,
                                GError **error);

Finishes an operation started with e_dbus_address_book_factory_proxy_new().

Parameters

res

The GAsyncResult obtained from the GAsyncReadyCallback passed to e_dbus_address_book_factory_proxy_new().

 

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type EDBusAddressBookFactoryProxy]

Since: 3.8


e_dbus_address_book_factory_proxy_new_sync ()

EDBusAddressBookFactory *
e_dbus_address_book_factory_proxy_new_sync
                               (GDBusConnection *connection,
                                GDBusProxyFlags flags,
                                const gchar *name,
                                const gchar *object_path,
                                GCancellable *cancellable,
                                GError **error);

Synchronously creates a proxy for the D-Bus interface org.gnome.evolution.dataserver.AddressBookFactory. See g_dbus_proxy_new_sync() for more details.

The calling thread is blocked until a reply is received.

See e_dbus_address_book_factory_proxy_new() for the asynchronous version of this constructor.

Parameters

connection

A GDBusConnection.

 

flags

Flags from the GDBusProxyFlags enumeration.

 

name

A bus name (well-known or unique) or NULL if connection is not a message bus connection.

[allow-none]

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[allow-none]

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type EDBusAddressBookFactoryProxy]

Since: 3.8


e_dbus_address_book_factory_proxy_new_for_bus ()

void
e_dbus_address_book_factory_proxy_new_for_bus
                               (GBusType bus_type,
                                GDBusProxyFlags flags,
                                const gchar *name,
                                const gchar *object_path,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Like e_dbus_address_book_factory_proxy_new() but takes a GBusType instead of a GDBusConnection.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call e_dbus_address_book_factory_proxy_new_for_bus_finish() to get the result of the operation.

See e_dbus_address_book_factory_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.

Parameters

bus_type

A GBusType.

 

flags

Flags from the GDBusProxyFlags enumeration.

 

name

A bus name (well-known or unique).

 

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[allow-none]

callback

A GAsyncReadyCallback to call when the request is satisfied.

 

user_data

User data to pass to callback .

 

Since: 3.8


e_dbus_address_book_factory_proxy_new_for_bus_finish ()

EDBusAddressBookFactory *
e_dbus_address_book_factory_proxy_new_for_bus_finish
                               (GAsyncResult *res,
                                GError **error);

Finishes an operation started with e_dbus_address_book_factory_proxy_new_for_bus().

Parameters

res

The GAsyncResult obtained from the GAsyncReadyCallback passed to e_dbus_address_book_factory_proxy_new_for_bus().

 

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type EDBusAddressBookFactoryProxy]

Since: 3.8


e_dbus_address_book_factory_proxy_new_for_bus_sync ()

EDBusAddressBookFactory *
e_dbus_address_book_factory_proxy_new_for_bus_sync
                               (GBusType bus_type,
                                GDBusProxyFlags flags,
                                const gchar *name,
                                const gchar *object_path,
                                GCancellable *cancellable,
                                GError **error);

Like e_dbus_address_book_factory_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.

The calling thread is blocked until a reply is received.

See e_dbus_address_book_factory_proxy_new_for_bus() for the asynchronous version of this constructor.

Parameters

bus_type

A GBusType.

 

flags

Flags from the GDBusProxyFlags enumeration.

 

name

A bus name (well-known or unique).

 

object_path

An object path.

 

cancellable

A GCancellable or NULL.

[allow-none]

error

Return location for error or NULL

 

Returns

The constructed proxy object or NULL if error is set.

[transfer full][type EDBusAddressBookFactoryProxy]

Since: 3.8


e_dbus_address_book_factory_skeleton_new ()

EDBusAddressBookFactory *
e_dbus_address_book_factory_skeleton_new
                               (void);

Creates a skeleton object for the D-Bus interface org.gnome.evolution.dataserver.AddressBookFactory.

Returns

The skeleton object.

[transfer full][type EDBusAddressBookFactorySkeleton]

Since: 3.8

Types and Values

struct EDBusAddressBookFactoryIface

struct EDBusAddressBookFactoryIface {
  GTypeInterface parent_iface;

  gboolean (*handle_open_address_book) (
    EDBusAddressBookFactory *object,
    GDBusMethodInvocation *invocation,
    const gchar *arg_source_uid);
};

Virtual table for the D-Bus interface org.gnome.evolution.dataserver.AddressBookFactory.

Members

GTypeInterface parent_iface;

The parent interface.

 

handle_open_address_book ()

Handler for the “handle-open-address-book” signal.

 

Since: 3.8


struct EDBusAddressBookFactoryProxy

struct EDBusAddressBookFactoryProxy;

The EDBusAddressBookFactoryProxy structure contains only private data and should only be accessed using the provided API.

Since: 3.8


struct EDBusAddressBookFactoryProxyClass

struct EDBusAddressBookFactoryProxyClass {
  GDBusProxyClass parent_class;
};

Class structure for EDBusAddressBookFactoryProxy.

Members

Since: 3.8


struct EDBusAddressBookFactorySkeleton

struct EDBusAddressBookFactorySkeleton;

The EDBusAddressBookFactorySkeleton structure contains only private data and should only be accessed using the provided API.

Since: 3.8


struct EDBusAddressBookFactorySkeletonClass

struct EDBusAddressBookFactorySkeletonClass {
  GDBusInterfaceSkeletonClass parent_class;
};

Class structure for EDBusAddressBookFactorySkeleton.

Members

Since: 3.8


EDBusAddressBookFactory

typedef struct _EDBusAddressBookFactory EDBusAddressBookFactory;

Abstract interface type for the D-Bus interface org.gnome.evolution.dataserver.AddressBookFactory.

Since: 3.8


EDBusAddressBookFactoryProxyPrivate

typedef struct _EDBusAddressBookFactoryProxyPrivate EDBusAddressBookFactoryProxyPrivate;

EDBusAddressBookFactorySkeletonPrivate

typedef struct _EDBusAddressBookFactorySkeletonPrivate EDBusAddressBookFactorySkeletonPrivate;

Signal Details

The “handle-open-address-book” signal

gboolean
user_function (EDBusAddressBookFactory *object,
               GDBusMethodInvocation   *invocation,
               gchar                   *arg_source_uid,
               gpointer                 user_data)

Signal emitted when a remote caller is invoking the OpenAddressBook() D-Bus method.

If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call e_dbus_address_book_factory_complete_open_address_book() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.

Parameters

object

A EDBusAddressBookFactory.

 

invocation

A GDBusMethodInvocation.

 

arg_source_uid

Argument passed by remote caller.

 

user_data

user data set when the signal handler was connected.

 

Returns

TRUE if the invocation was handled, FALSE to let other signal handlers run.

Flags: Run Last

Since: 3.8