EDBusAuthenticator

EDBusAuthenticator

Synopsis

                    EDBusAuthenticator;
gboolean            e_dbus_authenticator_call_ready_sync
                                                        (EDBusAuthenticator *proxy,
                                                         const gchar *arg_encryption_key,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_authenticator_call_ready     (EDBusAuthenticator *proxy,
                                                         const gchar *arg_encryption_key,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_authenticator_call_ready_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_authenticator_complete_ready (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);
gboolean            e_dbus_authenticator_call_cancel_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_authenticator_call_cancel    (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_authenticator_call_cancel_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_authenticator_complete_cancel
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);
gboolean            e_dbus_authenticator_call_accepted_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_authenticator_call_accepted  (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_authenticator_call_accepted_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_authenticator_complete_accepted
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);
gboolean            e_dbus_authenticator_call_rejected_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_authenticator_call_rejected  (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_authenticator_call_rejected_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_authenticator_complete_rejected
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);
void                e_dbus_authenticator_emit_authenticate
                                                        (EDBusAuthenticator *object,
                                                         const gchar *arg_encrypted_secret);
void                e_dbus_authenticator_emit_dismissed (EDBusAuthenticator *object);
GDBusInterfaceInfo * e_dbus_authenticator_interface_info
                                                        (void);
guint               e_dbus_authenticator_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Object Hierarchy

  GInterface
   +----EDBusAuthenticator

Prerequisites

EDBusAuthenticator requires GObject.

Known Implementations

EDBusAuthenticator is implemented by EDBusAuthenticatorProxy and EDBusAuthenticatorSkeleton.

Signals

  "authenticate"                                   : Run Last
  "dismissed"                                      : Run Last
  "handle-accepted"                                : Run Last
  "handle-cancel"                                  : Run Last
  "handle-ready"                                   : Run Last
  "handle-rejected"                                : Run Last

Description

Details

EDBusAuthenticator

typedef struct _EDBusAuthenticator EDBusAuthenticator;

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


e_dbus_authenticator_call_ready_sync ()

gboolean            e_dbus_authenticator_call_ready_sync
                                                        (EDBusAuthenticator *proxy,
                                                         const gchar *arg_encryption_key,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusAuthenticatorProxy.

arg_encryption_key :

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_authenticator_call_ready ()

void                e_dbus_authenticator_call_ready     (EDBusAuthenticator *proxy,
                                                         const gchar *arg_encryption_key,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Ready">Ready()</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_authenticator_call_ready_finish() to get the result of the operation.

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

proxy :

A EDBusAuthenticatorProxy.

arg_encryption_key :

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_authenticator_call_ready_finish ()

gboolean            e_dbus_authenticator_call_ready_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_authenticator_call_ready().

proxy :

A EDBusAuthenticatorProxy.

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_authenticator_complete_ready ()

void                e_dbus_authenticator_complete_ready (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);

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

invocation :

A GDBusMethodInvocation. [transfer full]

e_dbus_authenticator_call_cancel_sync ()

gboolean            e_dbus_authenticator_call_cancel_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_cancel ()

void                e_dbus_authenticator_call_cancel    (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Cancel">Cancel()</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_authenticator_call_cancel_finish() to get the result of the operation.

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_cancel_finish ()

gboolean            e_dbus_authenticator_call_cancel_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_authenticator_call_cancel().

proxy :

A EDBusAuthenticatorProxy.

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_authenticator_complete_cancel ()

void                e_dbus_authenticator_complete_cancel
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);

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

invocation :

A GDBusMethodInvocation. [transfer full]

e_dbus_authenticator_call_accepted_sync ()

gboolean            e_dbus_authenticator_call_accepted_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_accepted ()

void                e_dbus_authenticator_call_accepted  (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Accepted">Accepted()</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_authenticator_call_accepted_finish() to get the result of the operation.

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_accepted_finish ()

gboolean            e_dbus_authenticator_call_accepted_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_authenticator_call_accepted().

proxy :

A EDBusAuthenticatorProxy.

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_authenticator_complete_accepted ()

void                e_dbus_authenticator_complete_accepted
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);

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

invocation :

A GDBusMethodInvocation. [transfer full]

e_dbus_authenticator_call_rejected_sync ()

gboolean            e_dbus_authenticator_call_rejected_sync
                                                        (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_rejected ()

void                e_dbus_authenticator_call_rejected  (EDBusAuthenticator *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Rejected">Rejected()</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_authenticator_call_rejected_finish() to get the result of the operation.

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

proxy :

A EDBusAuthenticatorProxy.

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_authenticator_call_rejected_finish ()

gboolean            e_dbus_authenticator_call_rejected_finish
                                                        (EDBusAuthenticator *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_authenticator_call_rejected().

proxy :

A EDBusAuthenticatorProxy.

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_authenticator_complete_rejected ()

void                e_dbus_authenticator_complete_rejected
                                                        (EDBusAuthenticator *object,
                                                         GDBusMethodInvocation *invocation);

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

invocation :

A GDBusMethodInvocation. [transfer full]

e_dbus_authenticator_emit_authenticate ()

void                e_dbus_authenticator_emit_authenticate
                                                        (EDBusAuthenticator *object,
                                                         const gchar *arg_encrypted_secret);

Emits the <link linkend="gdbus-signal-org-gnome-evolution-dataserver-Authenticator.Authenticate">"Authenticate"</link> D-Bus signal.

object :

A EDBusAuthenticator.

arg_encrypted_secret :

Argument to pass with the signal.

e_dbus_authenticator_emit_dismissed ()

void                e_dbus_authenticator_emit_dismissed (EDBusAuthenticator *object);

Emits the <link linkend="gdbus-signal-org-gnome-evolution-dataserver-Authenticator.Dismissed">"Dismissed"</link> D-Bus signal.

object :

A EDBusAuthenticator.

e_dbus_authenticator_interface_info ()

GDBusInterfaceInfo * e_dbus_authenticator_interface_info
                                                        (void);

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

Returns :

A GDBusInterfaceInfo. Do not free. [transfer none]

e_dbus_authenticator_override_properties ()

guint               e_dbus_authenticator_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Overrides all GObject properties in the EDBusAuthenticator 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 "authenticate" signal

void                user_function                      (EDBusAuthenticator *object,
                                                        gchar              *arg_encrypted_secret,
                                                        gpointer            user_data)                 : Run Last

On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-evolution-dataserver-Authenticator.Authenticate">"Authenticate"</link> is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

object :

A EDBusAuthenticator.

arg_encrypted_secret :

Argument.

user_data :

user data set when the signal handler was connected.

The "dismissed" signal

void                user_function                      (EDBusAuthenticator *object,
                                                        gpointer            user_data)      : Run Last

On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-evolution-dataserver-Authenticator.Dismissed">"Dismissed"</link> is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

object :

A EDBusAuthenticator.

user_data :

user data set when the signal handler was connected.

The "handle-accepted" signal

gboolean            user_function                      (EDBusAuthenticator    *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Accepted">Accepted()</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_authenticator_complete_accepted() 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 EDBusAuthenticator.

invocation :

A GDBusMethodInvocation.

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.

The "handle-cancel" signal

gboolean            user_function                      (EDBusAuthenticator    *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Cancel">Cancel()</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_authenticator_complete_cancel() 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 EDBusAuthenticator.

invocation :

A GDBusMethodInvocation.

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.

The "handle-ready" signal

gboolean            user_function                      (EDBusAuthenticator    *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gchar                 *arg_encryption_key,
                                                        gpointer               user_data)               : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Ready">Ready()</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_authenticator_complete_ready() 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 EDBusAuthenticator.

invocation :

A GDBusMethodInvocation.

arg_encryption_key :

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.

The "handle-rejected" signal

gboolean            user_function                      (EDBusAuthenticator    *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-Authenticator.Rejected">Rejected()</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_authenticator_complete_rejected() 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 EDBusAuthenticator.

invocation :

A GDBusMethodInvocation.

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.