Service-side Channel Request interface: telepathy-glib API Reference Manual

Service-side Channel Request interface

Service-side Channel Request interface — GInterface for Telepathy ChannelRequest object

Functions

void	tp_svc_channel_request_return_from_proceed ()
void	(*tp_svc_channel_request_proceed_impl) ()
void	tp_svc_channel_request_implement_proceed ()
void	tp_svc_channel_request_return_from_cancel ()
void	(*tp_svc_channel_request_cancel_impl) ()
void	tp_svc_channel_request_implement_cancel ()
void	tp_svc_channel_request_emit_failed ()
void	tp_svc_channel_request_emit_succeeded ()
void	tp_svc_channel_request_emit_succeeded_with_channel ()

Signals

void	failed	Has Details
void	succeeded	Has Details
void	succeeded-with-channel	Has Details

Types and Values

	TpSvcChannelRequest
	TpSvcChannelRequestClass

Object Hierarchy

    GInterface
    ╰── TpSvcChannelRequest

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

This interface (auto-generated from the Telepathy spec) makes it easier to export an object implementing the Telepathy ChannelRequest interface, with the correct method and signal signatures, and emit signals from that object in a type-safe way.

You don't need these interfaces unless you're implementing a Telepathy ChannelDispatcher, such as Mission Control.

Functions

tp_svc_channel_request_return_from_proceed ()

void
tp_svc_channel_request_return_from_proceed
                               (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

Parameters

context

The D-Bus method invocation context

tp_svc_channel_request_proceed_impl ()

void
(*tp_svc_channel_request_proceed_impl)
                               (TpSvcChannelRequest *self,
                                DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method Proceed on interface org.freedesktop.Telepathy.ChannelRequest.

Parameters

self	The object implementing this interface
context	Used to return values or throw an error

tp_svc_channel_request_implement_proceed ()

void
tp_svc_channel_request_implement_proceed
                               (TpSvcChannelRequestClass *klass,
                                tp_svc_channel_request_proceed_impl impl);

Register an implementation for the Proceed method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass	A class whose instances implement this interface
impl	A callback used to implement the Proceed D-Bus method

tp_svc_channel_request_return_from_cancel ()

void
tp_svc_channel_request_return_from_cancel
                               (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

Parameters

context

The D-Bus method invocation context

tp_svc_channel_request_cancel_impl ()

void
(*tp_svc_channel_request_cancel_impl) (TpSvcChannelRequest *self,
                                       DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method Cancel on interface org.freedesktop.Telepathy.ChannelRequest.

Parameters

self	The object implementing this interface
context	Used to return values or throw an error

tp_svc_channel_request_implement_cancel ()

void
tp_svc_channel_request_implement_cancel
                               (TpSvcChannelRequestClass *klass,
                                tp_svc_channel_request_cancel_impl impl);

Register an implementation for the Cancel method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass	A class whose instances implement this interface
impl	A callback used to implement the Cancel D-Bus method

tp_svc_channel_request_emit_failed ()

void
tp_svc_channel_request_emit_failed (gpointer instance,
                                    const gchar *arg_Error,
                                    const gchar *arg_Message);

Type-safe wrapper around g_signal_emit to emit the Failed signal on interface org.freedesktop.Telepathy.ChannelRequest.

Parameters

instance	The object implementing this interface
arg_Error	const gchar * (FIXME, generate documentation)
arg_Message	const gchar * (FIXME, generate documentation)

tp_svc_channel_request_emit_succeeded ()

void
tp_svc_channel_request_emit_succeeded (gpointer instance);

Type-safe wrapper around g_signal_emit to emit the Succeeded signal on interface org.freedesktop.Telepathy.ChannelRequest.

Parameters

instance

The object implementing this interface

tp_svc_channel_request_emit_succeeded_with_channel ()

void
tp_svc_channel_request_emit_succeeded_with_channel
                               (gpointer instance,
                                const gchar *arg_Connection,
                                GHashTable *arg_Connection_Properties,
                                const gchar *arg_Channel,
                                GHashTable *arg_Channel_Properties);

Type-safe wrapper around g_signal_emit to emit the SucceededWithChannel signal on interface org.freedesktop.Telepathy.ChannelRequest.

Parameters

instance	The object implementing this interface
arg_Connection	const gchar * (FIXME, generate documentation)
arg_Connection_Properties	GHashTable * (FIXME, generate documentation)
arg_Channel	const gchar * (FIXME, generate documentation)
arg_Channel_Properties	GHashTable * (FIXME, generate documentation)

Types and Values

TpSvcChannelRequest

typedef struct _TpSvcChannelRequest TpSvcChannelRequest;

Dummy typedef representing any implementation of this interface.

TpSvcChannelRequestClass

typedef struct _TpSvcChannelRequestClass TpSvcChannelRequestClass;

The class of TpSvcChannelRequest.

In a full implementation of this interface (i.e. all methods implemented), the interface initialization function used in G_IMPLEMENT_INTERFACE() would typically look like this:

static void
implement_channel_request (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_request_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (proceed);
  IMPLEMENT (cancel);
#undef IMPLEMENT
}

Signal Details

The `“failed”` signal

void
user_function (TpSvcChannelRequest *self,
               gchar               *arg_Error,
               gchar               *arg_Message,
               gpointer             user_data)

The Failed D-Bus signal is emitted whenever this GObject signal is.

Parameters

self	an object
arg_Error	const gchar * (FIXME, generate documentation)
arg_Message	const gchar * (FIXME, generate documentation)
user_data	user data set when the signal handler was connected.

Flags: Has Details

The `“succeeded”` signal

void
user_function (TpSvcChannelRequest *self,
               gpointer             user_data)

The Succeeded D-Bus signal is emitted whenever this GObject signal is.

Parameters

self	an object
user_data	user data set when the signal handler was connected.

Flags: Has Details

The `“succeeded-with-channel”` signal

void
user_function (TpSvcChannelRequest *self,
               DBusGObjectPath     *arg_Connection,
               DBusGObjectPath     *arg_Channel,
               gpointer             user_data)

The SucceededWithChannel D-Bus signal is emitted whenever this GObject signal is.

Parameters

self	an object
arg_Connection	const gchar * (FIXME, generate documentation)
arg_Connection_Properties	GHashTable * (FIXME, generate documentation)
arg_Channel	const gchar * (FIXME, generate documentation)
arg_Channel_Properties	GHashTable * (FIXME, generate documentation)
user_data	user data set when the signal handler was connected.

Flags: Has Details