TpSimpleApprover

TpSimpleApprover — a subclass of TpBaseClient implementing a simple Approver

Functions

void (*TpSimpleApproverAddDispatchOperationImpl) ()
TpBaseClient * tp_simple_approver_new ()
TpBaseClient * tp_simple_approver_new_with_am ()

Properties

gpointer callback Write / Construct Only
gpointer destroy Write / Construct Only
gpointer user-data Write / Construct Only

Types and Values

struct TpSimpleApprover

Object Hierarchy

    GObject
    ╰── TpBaseClient
        ╰── TpSimpleApprover

Implemented Interfaces

TpSimpleApprover implements TpSvcClient, TpSvcClientObserver, TpSvcClientApprover, TpSvcClientHandler and TpSvcClientInterfaceRequests.

Includes

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

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
 
static void
my_add_dispatch_operation (TpSimpleApprover *approver,
   TpAccount *account,
   TpConnection *connection,
   TpChannel *channel,
   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);
}

client = tp_simple_approver_new (NULL, "MyApprover", FALSE,
   my_add_dispatch_operation, user_data);

tp_base_client_take_approver_filter (client,
     tp_channel_filter_new_for_text_chats ());

tp_base_client_register (client, NULL);

See examples/client/text-approver.c for a complete example.

Functions

TpSimpleApproverAddDispatchOperationImpl ()

void
(*TpSimpleApproverAddDispatchOperationImpl)
                               (TpSimpleApprover *approver,
                                TpAccount *account,
                                TpConnection *connection,
                                TpChannel *channel,
                                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.

Parameters

approver

a TpSimpleApprover instance

  

account

a TpAccount having TP_ACCOUNT_FEATURE_CORE prepared if possible

  

connection

a TpConnection having TP_CONNECTION_FEATURE_CORE prepared if possible

  

channel

a TpChannel having TP_CHANNEL_FEATURE_CORE prepared

  

dispatch_operation

a TpChannelDispatchOperation or NULL; the dispatch_operation is not guaranteed to be prepared.

[allow-none]

context

a TpAddDispatchOperationContext representing the context of this D-Bus call

  

user_data

arbitrary user-supplied data passed to tp_simple_approver_new()

  

Since 0.11.5

tp_simple_approver_new ()

TpBaseClient *
tp_simple_approver_new (TpClientFactory *factory,
                        const gchar *name,
                        gboolean uniquify,
                        TpSimpleApproverAddDispatchOperationImpl callback,
                        gpointer user_data,
                        GDestroyNotify destroy);

Convenient function to create a new TpSimpleApprover instance.

If factory is NULL a new TpAutomaticClientFactory will be used.

Parameters

factory

a TpClientFactory, or NULL

  

name

the name of the Approver (see “name” for details)

  

uniquify

the value of the “uniquify-name” property

  

callback

the function called when AddDispatchOperation is called

  

user_data

arbitrary user-supplied data passed to callback

 

destroy

called with user_data as its argument when the TpSimpleApprover is destroyed

  

Returns

a new TpSimpleApprover.

[type TelepathyGLib.SimpleApprover]

Since 0.99.1

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.

Parameters

account_manager

an account manager, which may not be NULL

  

name

the name of the Approver (see “name” for details)

  

uniquify

the value of the “uniquify-name” property

  

callback

the function called when AddDispatchOperation is called

  

user_data

arbitrary user-supplied data passed to callback

 

destroy

called with user_data as its argument when the TpSimpleApprover is destroyed

  

Returns

a new TpSimpleApprover.

[type TelepathyGLib.SimpleApprover]

Since 0.11.14

Types and Values

struct TpSimpleApprover

struct TpSimpleApprover;

Data structure representing a simple Approver implementation.

Since 0.11.5

Property Details

The “callback” property

  “callback”                 gpointer

The TpSimpleApproverAddDispatchOperationImpl callback implementing the AddDispatchOperation D-Bus method.

This property can't be NULL.

Flags: Write / Construct Only

Since 0.11.5

The “destroy” property

  “destroy”                  gpointer

The GDestroyNotify function called to free “user-data” when the TpSimpleApprover is destroyed.

Flags: Write / Construct Only

Since 0.11.5

The “user-data” property

  “user-data”                gpointer

The user-data pointer passed to “callback”.

Flags: Write / Construct Only

Since 0.11.5

Generated by GTK-Doc V1.20