 |
 |
 |
telepathy-glib API Reference Manual |  |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
TpSimpleApproverTpSimpleApprover — a subclass of TpBaseClient implementing a simple Approver |
Synopsis
#include <telepathy-glib/telepathy-glib.h>
TpSimpleApprover;
void (*TpSimpleApproverAddDispatchOperationImpl)
(TpSimpleApprover *approver,
TpAccount *account,
TpConnection *connection,
GList *channels,
TpChannelDispatchOperation *dispatch_operation,
TpAddDispatchOperationContext *context,
gpointer user_data);
TpBaseClient * tp_simple_approver_new (TpDBusDaemon *dbus,
const gchar *name,
gboolean uniquify,
TpSimpleApproverAddDispatchOperationImpl callback,
gpointer user_data,
GDestroyNotify destroy);
TpBaseClient * tp_simple_approver_new_with_am (TpAccountManager *account_manager,
const gchar *name,
gboolean uniquify,
TpSimpleApproverAddDispatchOperationImpl callback,
gpointer user_data,
GDestroyNotify destroy);
TpBaseClient * tp_simple_approver_new_with_factory (TpSimpleClientFactory *factory,
const gchar *name,
gboolean uniquify,
TpSimpleApproverAddDispatchOperationImpl callback,
gpointer user_data,
GDestroyNotify destroy);
Implemented Interfaces
TpSimpleApprover implements TpSvcDBusProperties, TpSvcClient, TpSvcClientObserver, TpSvcClientApprover, TpSvcClientHandler and TpSvcClientInterfaceRequests.
Properties
"callback" gpointer : Write / Construct Only "destroy" gpointer : Write / Construct Only "user-data" gpointer : Write / Construct Only
Description
This class makes it easier to construct a TpSvcClient implementing the TpSvcClientApprover interface.
A typical simple approver would look liks this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
static void my_add_dispatch_operation (TpSimpleApprover *approver, TpAccount *account, TpConnection *connection, GList *channels, TpChannelDispatchOperation *dispatch_operation, TpAddDispatchOperationContext *context, gpointer user_data) { /* call tp_channel_dispatch_operation_handle_with_async() if wanting to approve the channels */ tp_add_dispatch_operation_context_accept (context); } factory = tp_automatic_client_factory_new (dbus); client = tp_simple_approver_new_with_factory (factory, "MyApprover", FALSE, my_add_dispatch_operation, user_data); g_object_unref (factory); tp_base_client_take_approver_filter (client, tp_asv_new ( TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING, TP_IFACE_CHANNEL_TYPE_TEXT, TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_CONTACT, NULL)); tp_base_client_register (client, NULL); |
See examples/client/text-approver.c for a complete example.
Details
TpSimpleApprover
typedef struct _TpSimpleApprover TpSimpleApprover;
Data structure representing a simple Approver implementation.
Since 0.11.5
TpSimpleApproverAddDispatchOperationImpl ()
void (*TpSimpleApproverAddDispatchOperationImpl) (TpSimpleApprover *approver,TpAccount *account,TpConnection *connection,GList *channels,TpChannelDispatchOperation *dispatch_operation,TpAddDispatchOperationContext *context,gpointer user_data);
Signature of the implementation of the AddDispatchOperation method.
This function must call either tp_add_dispatch_operation_context_accept(),
tp_add_dispatch_operation_context_delay() or
tp_add_dispatch_operation_context_fail() on context before it returns.
|
a TpSimpleApprover instance |
|
a TpAccount having TP_ACCOUNT_FEATURE_CORE prepared if possible |
|
a TpConnection having TP_CONNECTION_FEATURE_CORE prepared
if possible |
|
a GList of TpChannel,
all having TP_CHANNEL_FEATURE_CORE prepared. [element-type TelepathyGLib.Channel]
|
|
a TpChannelDispatchOperation or NULL;
the dispatch_operation is not guaranteed to be prepared. [allow-none]
|
|
a TpAddDispatchOperationContext representing the context of this D-Bus call |
|
arbitrary user-supplied data passed to tp_simple_approver_new()
|
Since 0.11.5
tp_simple_approver_new ()
TpBaseClient * tp_simple_approver_new (TpDBusDaemon *dbus,const gchar *name,gboolean uniquify,TpSimpleApproverAddDispatchOperationImpl callback,gpointer user_data,GDestroyNotify destroy);
Warning
tp_simple_approver_new is deprecated and should not be used in newly-written code. New code should use tp_simple_approver_new_with_am() instead.
Convenient function to create a new TpSimpleApprover instance.
If dbus is not the result of tp_dbus_daemon_dup(), you should call
tp_simple_approver_new_with_am() instead, so that TpAccount,
TpConnection and TpContact instances can be shared between modules.
|
a TpDBusDaemon object, may not be NULL
|
|
the name of the Approver (see "name" for details) |
|
the value of the "uniquify-name" property |
|
the function called when AddDispatchOperation is called |
|
arbitrary user-supplied data passed to callback
|
|
called with user_data as its argument when the TpSimpleApprover
is destroyed |
Returns : |
a new TpSimpleApprover. [type TelepathyGLib.SimpleApprover] |
Since 0.11.5
tp_simple_approver_new_with_am ()
TpBaseClient * tp_simple_approver_new_with_am (TpAccountManager *account_manager,const gchar *name,gboolean uniquify,TpSimpleApproverAddDispatchOperationImpl callback,gpointer user_data,GDestroyNotify destroy);
Convenient function to create a new TpSimpleApprover instance with a specified TpAccountManager.
It is not necessary to prepare any features on account_manager before
calling this function.
|
an account manager, which may not be NULL
|
|
the name of the Approver (see "name" for details) |
|
the value of the "uniquify-name" property |
|
the function called when AddDispatchOperation is called |
|
arbitrary user-supplied data passed to callback
|
|
called with user_data as its argument when the TpSimpleApprover
is destroyed |
Returns : |
a new TpSimpleApprover. [type TelepathyGLib.SimpleApprover] |
Since 0.11.14
tp_simple_approver_new_with_factory ()
TpBaseClient * tp_simple_approver_new_with_factory (TpSimpleClientFactory *factory,const gchar *name,gboolean uniquify,TpSimpleApproverAddDispatchOperationImpl callback,gpointer user_data,GDestroyNotify destroy);
Convenient function to create a new TpSimpleApprover instance with a specified TpSimpleClientFactory.
|
an TpSimpleClientFactory, which may not be NULL
|
|
the name of the Approver (see "name" for details) |
|
the value of the "uniquify-name" property |
|
the function called when AddDispatchOperation is called |
|
arbitrary user-supplied data passed to callback
|
|
called with user_data as its argument when the TpSimpleApprover
is destroyed |
Returns : |
a new TpSimpleApprover. [type TelepathyGLib.SimpleApprover] |
Since 0.15.5
Property Details
The "callback" property
"callback" gpointer : Write / Construct Only
The TpSimpleApproverAddDispatchOperationImpl callback implementing the AddDispatchOperation D-Bus method.
This property can't be NULL.
Since 0.11.5
The "destroy" property
"destroy" gpointer : Write / Construct Only
The GDestroyNotify function called to free "user-data" when the TpSimpleApprover is destroyed.
Since 0.11.5
The "user-data" property
"user-data" gpointer : Write / Construct Only
The user-data pointer passed to "callback".
Since 0.11.5