EDBusUserPrompter

EDBusUserPrompter

Synopsis

                    EDBusUserPrompter;
gboolean            e_dbus_user_prompter_call_extension_prompt_sync
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_dialog_name,
                                                         const gchar *const *arg_parameters,
                                                         gint *out_id,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_user_prompter_call_extension_prompt
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_dialog_name,
                                                         const gchar *const *arg_parameters,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_user_prompter_call_extension_prompt_finish
                                                        (EDBusUserPrompter *proxy,
                                                         gint *out_id,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_user_prompter_complete_extension_prompt
                                                        (EDBusUserPrompter *object,
                                                         GDBusMethodInvocation *invocation,
                                                         gint id);
gboolean            e_dbus_user_prompter_call_prompt_sync
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_type,
                                                         const gchar *arg_title,
                                                         const gchar *arg_primary_text,
                                                         const gchar *arg_secondary_text,
                                                         gboolean arg_use_markup,
                                                         const gchar *const *arg_button_captions,
                                                         gint *out_id,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                e_dbus_user_prompter_call_prompt    (EDBusUserPrompter *proxy,
                                                         const gchar *arg_type,
                                                         const gchar *arg_title,
                                                         const gchar *arg_primary_text,
                                                         const gchar *arg_secondary_text,
                                                         gboolean arg_use_markup,
                                                         const gchar *const *arg_button_captions,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            e_dbus_user_prompter_call_prompt_finish
                                                        (EDBusUserPrompter *proxy,
                                                         gint *out_id,
                                                         GAsyncResult *res,
                                                         GError **error);
void                e_dbus_user_prompter_complete_prompt
                                                        (EDBusUserPrompter *object,
                                                         GDBusMethodInvocation *invocation,
                                                         gint id);
void                e_dbus_user_prompter_emit_extension_response
                                                        (EDBusUserPrompter *object,
                                                         gint arg_id,
                                                         gint arg_response,
                                                         const gchar *const *arg_values);
void                e_dbus_user_prompter_emit_response  (EDBusUserPrompter *object,
                                                         gint arg_id,
                                                         gint arg_response_button);
GDBusInterfaceInfo * e_dbus_user_prompter_interface_info
                                                        (void);
guint               e_dbus_user_prompter_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Object Hierarchy

  GInterface
   +----EDBusUserPrompter

Prerequisites

EDBusUserPrompter requires GObject.

Known Implementations

EDBusUserPrompter is implemented by EDBusUserPrompterProxy and EDBusUserPrompterSkeleton.

Signals

  "extension-response"                             : Run Last
  "handle-extension-prompt"                        : Run Last
  "handle-prompt"                                  : Run Last
  "response"                                       : Run Last

Description

Details

EDBusUserPrompter

typedef struct _EDBusUserPrompter EDBusUserPrompter;

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


e_dbus_user_prompter_call_extension_prompt_sync ()

gboolean            e_dbus_user_prompter_call_extension_prompt_sync
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_dialog_name,
                                                         const gchar *const *arg_parameters,
                                                         gint *out_id,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusUserPrompterProxy.

arg_dialog_name :

Argument to pass with the method invocation.

arg_parameters :

Argument to pass with the method invocation.

out_id :

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]

e_dbus_user_prompter_call_extension_prompt ()

void                e_dbus_user_prompter_call_extension_prompt
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_dialog_name,
                                                         const gchar *const *arg_parameters,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

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

proxy :

A EDBusUserPrompterProxy.

arg_dialog_name :

Argument to pass with the method invocation.

arg_parameters :

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

gboolean            e_dbus_user_prompter_call_extension_prompt_finish
                                                        (EDBusUserPrompter *proxy,
                                                         gint *out_id,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_user_prompter_call_extension_prompt().

proxy :

A EDBusUserPrompterProxy.

out_id :

Return location for return parameter or NULL to ignore. [out]

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_user_prompter_complete_extension_prompt ()

void                e_dbus_user_prompter_complete_extension_prompt
                                                        (EDBusUserPrompter *object,
                                                         GDBusMethodInvocation *invocation,
                                                         gint id);

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

invocation :

A GDBusMethodInvocation. [transfer full]

id :

Parameter to return.

e_dbus_user_prompter_call_prompt_sync ()

gboolean            e_dbus_user_prompter_call_prompt_sync
                                                        (EDBusUserPrompter *proxy,
                                                         const gchar *arg_type,
                                                         const gchar *arg_title,
                                                         const gchar *arg_primary_text,
                                                         const gchar *arg_secondary_text,
                                                         gboolean arg_use_markup,
                                                         const gchar *const *arg_button_captions,
                                                         gint *out_id,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

A EDBusUserPrompterProxy.

arg_type :

Argument to pass with the method invocation.

arg_title :

Argument to pass with the method invocation.

arg_primary_text :

Argument to pass with the method invocation.

arg_secondary_text :

Argument to pass with the method invocation.

arg_use_markup :

Argument to pass with the method invocation.

arg_button_captions :

Argument to pass with the method invocation.

out_id :

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]

e_dbus_user_prompter_call_prompt ()

void                e_dbus_user_prompter_call_prompt    (EDBusUserPrompter *proxy,
                                                         const gchar *arg_type,
                                                         const gchar *arg_title,
                                                         const gchar *arg_primary_text,
                                                         const gchar *arg_secondary_text,
                                                         gboolean arg_use_markup,
                                                         const gchar *const *arg_button_captions,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

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

proxy :

A EDBusUserPrompterProxy.

arg_type :

Argument to pass with the method invocation.

arg_title :

Argument to pass with the method invocation.

arg_primary_text :

Argument to pass with the method invocation.

arg_secondary_text :

Argument to pass with the method invocation.

arg_use_markup :

Argument to pass with the method invocation.

arg_button_captions :

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

gboolean            e_dbus_user_prompter_call_prompt_finish
                                                        (EDBusUserPrompter *proxy,
                                                         gint *out_id,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with e_dbus_user_prompter_call_prompt().

proxy :

A EDBusUserPrompterProxy.

out_id :

Return location for return parameter or NULL to ignore. [out]

res :

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

error :

Return location for error or NULL.

Returns :

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

e_dbus_user_prompter_complete_prompt ()

void                e_dbus_user_prompter_complete_prompt
                                                        (EDBusUserPrompter *object,
                                                         GDBusMethodInvocation *invocation,
                                                         gint id);

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

invocation :

A GDBusMethodInvocation. [transfer full]

id :

Parameter to return.

e_dbus_user_prompter_emit_extension_response ()

void                e_dbus_user_prompter_emit_extension_response
                                                        (EDBusUserPrompter *object,
                                                         gint arg_id,
                                                         gint arg_response,
                                                         const gchar *const *arg_values);

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

object :

A EDBusUserPrompter.

arg_id :

Argument to pass with the signal.

arg_response :

Argument to pass with the signal.

arg_values :

Argument to pass with the signal.

e_dbus_user_prompter_emit_response ()

void                e_dbus_user_prompter_emit_response  (EDBusUserPrompter *object,
                                                         gint arg_id,
                                                         gint arg_response_button);

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

object :

A EDBusUserPrompter.

arg_id :

Argument to pass with the signal.

arg_response_button :

Argument to pass with the signal.

e_dbus_user_prompter_interface_info ()

GDBusInterfaceInfo * e_dbus_user_prompter_interface_info
                                                        (void);

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

Returns :

A GDBusInterfaceInfo. Do not free. [transfer none]

e_dbus_user_prompter_override_properties ()

guint               e_dbus_user_prompter_override_properties
                                                        (GObjectClass *klass,
                                                         guint property_id_begin);

Overrides all GObject properties in the EDBusUserPrompter 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 "extension-response" signal

void                user_function                      (EDBusUserPrompter *object,
                                                        gint               arg_id,
                                                        gint               arg_response,
                                                        GStrv              arg_values,
                                                        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-UserPrompter.ExtensionResponse">"ExtensionResponse"</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 EDBusUserPrompter.

arg_id :

Argument.

arg_response :

Argument.

arg_values :

Argument.

user_data :

user data set when the signal handler was connected.

The "handle-extension-prompt" signal

gboolean            user_function                      (EDBusUserPrompter     *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gchar                 *arg_dialog_name,
                                                        GStrv                  arg_parameters,
                                                        gpointer               user_data)            : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-UserPrompter.ExtensionPrompt">ExtensionPrompt()</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_user_prompter_complete_extension_prompt() 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 EDBusUserPrompter.

invocation :

A GDBusMethodInvocation.

arg_dialog_name :

Argument passed by remote caller.

arg_parameters :

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-prompt" signal

gboolean            user_function                      (EDBusUserPrompter     *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gchar                 *arg_type,
                                                        gchar                 *arg_title,
                                                        gchar                 *arg_primary_text,
                                                        gchar                 *arg_secondary_text,
                                                        gboolean               arg_use_markup,
                                                        GStrv                  arg_button_captions,
                                                        gpointer               user_data)                : Run Last

Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-evolution-dataserver-UserPrompter.Prompt">Prompt()</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_user_prompter_complete_prompt() 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 EDBusUserPrompter.

invocation :

A GDBusMethodInvocation.

arg_type :

Argument passed by remote caller.

arg_title :

Argument passed by remote caller.

arg_primary_text :

Argument passed by remote caller.

arg_secondary_text :

Argument passed by remote caller.

arg_use_markup :

Argument passed by remote caller.

arg_button_captions :

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 "response" signal

void                user_function                      (EDBusUserPrompter *object,
                                                        gint               arg_id,
                                                        gint               arg_response_button,
                                                        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-UserPrompter.Response">"Response"</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 EDBusUserPrompter.

arg_id :

Argument.

arg_response_button :

Argument.

user_data :

user data set when the signal handler was connected.