![]() |
![]() |
![]() |
telepathy-glib Reference Manual | ![]() |
---|---|---|---|---|
TpProxy D-Bus core methodsTpProxy D-Bus core methods — The D-Bus Introspectable, Peer and Properties interfaces |
#include <telepathy-glib/proxy.h> TpProxyPendingCall* tp_cli_dbus_introspectable_call_introspect (gpointer proxy, gint timeout_ms, tp_cli_dbus_introspectable_callback_for_introspect callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); void (*tp_cli_dbus_introspectable_callback_for_introspect) (TpProxy *proxy, const gchar *out_XML_Data, const GError *error, gpointer user_data, GObject *weak_object); gboolean tp_cli_dbus_introspectable_run_introspect (gpointer proxy, gint timeout_ms, gchar **out_XML_Data, GError **error, GMainLoop **loop); TpProxyPendingCall* tp_cli_dbus_peer_call_get_machine_id (gpointer proxy, gint timeout_ms, tp_cli_dbus_peer_callback_for_get_machine_id callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); TpProxyPendingCall* tp_cli_dbus_peer_call_ping (gpointer proxy, gint timeout_ms, tp_cli_dbus_peer_callback_for_ping callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); void (*tp_cli_dbus_peer_callback_for_get_machine_id) (TpProxy *proxy, const gchar *out_Machine_UUID, const GError *error, gpointer user_data, GObject *weak_object); void (*tp_cli_dbus_peer_callback_for_ping) (TpProxy *proxy, const GError *error, gpointer user_data, GObject *weak_object); gboolean tp_cli_dbus_peer_run_get_machine_id (gpointer proxy, gint timeout_ms, gchar **out_Machine_UUID, GError **error, GMainLoop **loop); gboolean tp_cli_dbus_peer_run_ping (gpointer proxy, gint timeout_ms, GError **error, GMainLoop **loop); TpProxyPendingCall* tp_cli_dbus_properties_call_get (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, tp_cli_dbus_properties_callback_for_get callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); TpProxyPendingCall* tp_cli_dbus_properties_call_get_all (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, tp_cli_dbus_properties_callback_for_get_all callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); TpProxyPendingCall* tp_cli_dbus_properties_call_set (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, const GValue *in_Value, tp_cli_dbus_properties_callback_for_set callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object); void (*tp_cli_dbus_properties_callback_for_get) (TpProxy *proxy, const GValue *out_Value, const GError *error, gpointer user_data, GObject *weak_object); void (*tp_cli_dbus_properties_callback_for_get_all) (TpProxy *proxy, GHashTable *out_Properties, const GError *error, gpointer user_data, GObject *weak_object); void (*tp_cli_dbus_properties_callback_for_set) (TpProxy *proxy, const GError *error, gpointer user_data, GObject *weak_object); gboolean tp_cli_dbus_properties_run_get (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, GValue **out_Value, GError **error, GMainLoop **loop); gboolean tp_cli_dbus_properties_run_get_all (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, GHashTable **out_Properties, GError **error, GMainLoop **loop); gboolean tp_cli_dbus_properties_run_set (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, const GValue *in_Value, GError **error, GMainLoop **loop);
All D-Bus objects support the Peer interface, and many support the Introspectable and Properties interfaces.
TpProxyPendingCall* tp_cli_dbus_introspectable_call_introspect (gpointer proxy, gint timeout_ms, tp_cli_dbus_introspectable_callback_for_introspect callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a Introspect method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
void (*tp_cli_dbus_introspectable_callback_for_introspect) (TpProxy *proxy, const gchar *out_XML_Data, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a Introspect method call succeeds or fails.
proxy : |
the proxy on which the call was made |
out_XML_Data : |
Used to return an 'out' argument if error is NULL : (Undocumented)
|
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
gboolean tp_cli_dbus_introspectable_run_introspect (gpointer proxy, gint timeout_ms, gchar **out_XML_Data, GError **error, GMainLoop **loop);
Call the method Introspect and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
out_XML_Data : |
Used to return an 'out' argument if TRUE is returned: (Undocumented)
|
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|
TpProxyPendingCall* tp_cli_dbus_peer_call_get_machine_id (gpointer proxy, gint timeout_ms, tp_cli_dbus_peer_callback_for_get_machine_id callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a GetMachineId method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
TpProxyPendingCall* tp_cli_dbus_peer_call_ping (gpointer proxy, gint timeout_ms, tp_cli_dbus_peer_callback_for_ping callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a Ping method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
void (*tp_cli_dbus_peer_callback_for_get_machine_id) (TpProxy *proxy, const gchar *out_Machine_UUID, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a GetMachineId method call succeeds or fails.
proxy : |
the proxy on which the call was made |
out_Machine_UUID : |
Used to return an 'out' argument if error is NULL : (Undocumented)
|
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
void (*tp_cli_dbus_peer_callback_for_ping) (TpProxy *proxy, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a Ping method call succeeds or fails.
proxy : |
the proxy on which the call was made |
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
gboolean tp_cli_dbus_peer_run_get_machine_id (gpointer proxy, gint timeout_ms, gchar **out_Machine_UUID, GError **error, GMainLoop **loop);
Call the method GetMachineId and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
out_Machine_UUID : |
Used to return an 'out' argument if TRUE is returned: (Undocumented)
|
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|
gboolean tp_cli_dbus_peer_run_ping (gpointer proxy, gint timeout_ms, GError **error, GMainLoop **loop);
Call the method Ping and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|
TpProxyPendingCall* tp_cli_dbus_properties_call_get (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, tp_cli_dbus_properties_callback_for_get callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a Get method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Property_Name : |
Used to pass an 'in' argument: (Undocumented) |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
TpProxyPendingCall* tp_cli_dbus_properties_call_get_all (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, tp_cli_dbus_properties_callback_for_get_all callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a GetAll method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
TpProxyPendingCall* tp_cli_dbus_properties_call_set (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, const GValue *in_Value, tp_cli_dbus_properties_callback_for_set callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object);
Start a Set method call.
(Undocumented)
proxy : |
the TpProxy |
timeout_ms : |
the timeout in milliseconds, or -1 to use the default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Property_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Value : |
Used to pass an 'in' argument: (Undocumented) |
callback : |
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking
|
user_data : |
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
destroy : |
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
weak_object : |
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : | a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
void (*tp_cli_dbus_properties_callback_for_get) (TpProxy *proxy, const GValue *out_Value, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a Get method call succeeds or fails.
proxy : |
the proxy on which the call was made |
out_Value : |
Used to return an 'out' argument if error is NULL : (Undocumented)
|
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
void (*tp_cli_dbus_properties_callback_for_get_all) (TpProxy *proxy, GHashTable *out_Properties, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a GetAll method call succeeds or fails.
proxy : |
the proxy on which the call was made |
out_Properties : |
Used to return an 'out' argument if error is NULL : (Undocumented)
|
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
void (*tp_cli_dbus_properties_callback_for_set) (TpProxy *proxy, const GError *error, gpointer user_data, GObject *weak_object);
Signature of the callback called when a Set method call succeeds or fails.
proxy : |
the proxy on which the call was made |
error : |
NULL on success, or an error on failure
|
user_data : |
user-supplied data |
weak_object : |
user-supplied object |
gboolean tp_cli_dbus_properties_run_get (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, GValue **out_Value, GError **error, GMainLoop **loop);
Call the method Get and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Property_Name : |
Used to pass an 'in' argument: (Undocumented) |
out_Value : |
Used to return an 'out' argument if TRUE is returned: (Undocumented)
|
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|
gboolean tp_cli_dbus_properties_run_get_all (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, GHashTable **out_Properties, GError **error, GMainLoop **loop);
Call the method GetAll and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
out_Properties : |
Used to return an 'out' argument if TRUE is returned: (Undocumented)
|
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|
gboolean tp_cli_dbus_properties_run_set (gpointer proxy, gint timeout_ms, const gchar *in_Interface_Name, const gchar *in_Property_Name, const GValue *in_Value, GError **error, GMainLoop **loop);
Call the method Set and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
(Undocumented)
proxy : |
A TpProxy or subclass |
timeout_ms : |
Timeout in milliseconds, or -1 for default |
in_Interface_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Property_Name : |
Used to pass an 'in' argument: (Undocumented) |
in_Value : |
Used to pass an 'in' argument: (Undocumented) |
error : |
If not NULL , used to return errors if FALSE
is returned
|
loop : |
If not NULL , set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call with
g_main_loop_quit() , causing a return of
FALSE with error set to TP_DBUS_ERROR_CANCELLED
|
Returns : | TRUE on success, FALSE and sets error on error
|