EDBusSourceWritable

EDBusSourceWritable

Synopsis

                    EDBusSourceWritable;
gboolean            e_dbus_source_writable_call_write_sync
                                                        (EDBusSourceWritable *proxy,
                                                         const gchar *arg_data,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_source_writable_call_write   (EDBusSourceWritable *proxy,
                                                         const gchar *arg_data,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_source_writable_call_write_finish
                                                        (EDBusSourceWritable *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_source_writable_complete_write
                                                        (EDBusSourceWritable *object,
                                                         GDBusMethodInvocation *invocation);
GDBusInterfaceInfo * e_dbus_source_writable_interface_info
                                                        (void);
guint               e_dbus_source_writable_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Object Hierarchy

  GInterface
   +----EDBusSourceWritable

Prerequisites

EDBusSourceWritable requires GObject.

Known Implementations

EDBusSourceWritable is implemented by EDBusSourceWritableProxy and EDBusSourceWritableSkeleton.

Signals

  "handle-write"                                   : Run Last

Description

Details

EDBusSourceWritable

typedef struct _EDBusSourceWritable EDBusSourceWritable;

Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-evolution-dataserver-Source-Writable.top_of_page">org.gnome.evolution.dataserver.Source.Writable</link>.


e_dbus_source_writable_call_write_sync ()

gboolean            e_dbus_source_writable_call_write_sync
                                                        (EDBusSourceWritable *proxy,
                                                         const gchar *arg_data,
                                                         GCancellable *cancellable,
                                                         GError **error);

Synchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Source-Writable.Write">Write()</link> D-Bus method on proxy. The calling thread is blocked until a reply is received.

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

proxy :

A EDBusSourceWritableProxy.

arg_data :

Argument to pass with the method invocation.

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]

e_dbus_source_writable_call_write ()

void                e_dbus_source_writable_call_write   (EDBusSourceWritable *proxy,
                                                         const gchar *arg_data,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Source-Writable.Write">Write()</link> D-Bus method on proxy. When the operation is finished, callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. You can then call e_dbus_source_writable_call_write_finish() to get the result of the operation.

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

proxy :

A EDBusSourceWritableProxy.

arg_data :

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.

e_dbus_source_writable_call_write_finish ()

gboolean            e_dbus_source_writable_call_write_finish
                                                        (EDBusSourceWritable *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_source_writable_call_write().

proxy :

A EDBusSourceWritableProxy.

res :

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

error :

Return location for error or NULL.

Returns :

TRUE if the call succeded, FALSE if error is set. [skip]

e_dbus_source_writable_complete_write ()

void                e_dbus_source_writable_complete_write
                                                        (EDBusSourceWritable *object,
                                                         GDBusMethodInvocation *invocation);

Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Source-Writable.Write">Write()</link> 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.

object :

A EDBusSourceWritable.

invocation :

A GDBusMethodInvocation. [transfer full]

e_dbus_source_writable_interface_info ()

GDBusInterfaceInfo * e_dbus_source_writable_interface_info
                                                        (void);

Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-evolution-dataserver-Source-Writable.top_of_page">org.gnome.evolution.dataserver.Source.Writable</link> D-Bus interface.

Returns :

A GDBusInterfaceInfo. Do not free. [transfer none]

e_dbus_source_writable_override_properties ()

guint               e_dbus_source_writable_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

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

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.

Signal Details

The "handle-write" signal

gboolean            user_function                      (EDBusSourceWritable   *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gchar                 *arg_data,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Source-Writable.Write">Write()</link> 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_source_writable_complete_write() 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.

object :

A EDBusSourceWritable.

invocation :

A GDBusMethodInvocation.

arg_data :

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.