TpHandleChannelContext

TpHandleChannelContext — context of a Handler.HandleChannels() call

Functions

Properties

TpAccount * account Read / Write / Construct Only
TpChannel * channel Read / Write / Construct Only
TpConnection * connection Read / Write / Construct Only
gpointer dbus-context Write / Construct Only
GVariant * handler-info Read / Write / Construct Only
GPtrArray * requests-satisfied Read / Write / Construct Only
gint64 user-action-time Read / Write / Construct Only

Signals

void done Has Details

Types and Values

Object Hierarchy

    GObject
    ╰── TpHandleChannelContext

Includes

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

Description

Object used to represent the context of a Handler.HandleChannels() D-Bus call on a TpBaseClient.

Functions

tp_handle_channel_context_accept ()

void
tp_handle_channel_context_accept (TpHandleChannelContext *self);

Called by TpBaseClientClassAddDispatchOperationImpl when it's done so the D-Bus method can return.

The caller is responsible for closing channels with tp_cli_channel_call_close() when it has finished handling them.

Parameters

Since 0.11.6


tp_handle_channel_context_delay ()

void
tp_handle_channel_context_delay (TpHandleChannelContext *self);

Called by TpBaseClientClassAddDispatchOperationImpl to indicate that it implements the method in an async way. The caller must take a reference to the TpHandleChannelContext before calling this function, and is responsible for calling either tp_handle_channel_context_accept() or tp_handle_channel_context_fail() later.

Parameters

Since 0.11.6


tp_handle_channel_context_fail ()

void
tp_handle_channel_context_fail (TpHandleChannelContext *self,
                                const GError *error);

Called by TpBaseClientClassAddDispatchOperationImpl to raise a D-Bus error.

Parameters

self

a TpHandleChannelContext

 

error

the error to return from the method

 

Since 0.11.6


tp_handle_channel_context_dup_handler_info ()

GVariant *
tp_handle_channel_context_dup_handler_info
                               (TpHandleChannelContext *self);

Return any extra information that accompanied this request to handle channels (the Handler_Info argument from the HandleChannels D-Bus method). Well-known keys for this map will be defined by the Telepathy D-Bus Interface Specification; at the time of writing, none have been defined.

Parameters

self

a channel-handling context

 

Returns

a G_VARIANT_TYPE_VARDICT Gvariant containing the extra handler information.

[transfer full]


tp_handle_channel_context_get_requests ()

GList *
tp_handle_channel_context_get_requests
                               (TpHandleChannelContext *self);

Return a list of the TpChannelRequest which have been satisfied by the channels associated with self.

Parameters

self

a channel-handling context

 

Returns

a newly allocated GList of reffed TpChannelRequest.

[transfer full][element-type TelepathyGLib.ChannelRequest]

Since 0.13.14

Types and Values

TpHandleChannelContext

typedef struct _TpHandleChannelContext TpHandleChannelContext;

Data structure representing the context of a Handler.HandleChannels() call.

Since 0.11.6

Property Details

The “account” property

  “account”                  TpAccount *

A TpAccount object representing the Account of the DispatchOperation that has been passed to HandleChannels. Read-only except during construction.

This property can't be NULL.

Flags: Read / Write / Construct Only

Since 0.11.6


The “channel” property

  “channel”                  TpChannel *

A TpChannel object representing the channel that has been passed to HandleChannel. Read-only except during construction.

This property can't be NULL.

Flags: Read / Write / Construct Only


The “connection” property

  “connection”               TpConnection *

A TpConnection object representing the Connection of the DispatchOperation that has been passed to HandleChannels. Read-only except during construction.

This property can't be NULL.

Flags: Read / Write / Construct Only

Since 0.11.6


The “dbus-context” property

  “dbus-context”             gpointer

The GDBusMethodInvocation representing the D-Bus context of the HandleChannels call. Can only be written during construction.

Flags: Write / Construct Only

Since 0.11.6


The “handler-info” property

  “handler-info”             GVariant *

A G_VARIANT_TYPE_VARDICT GVariant containing the Handler_Info dictionnary that has been passed to HandleChannels.

This property can't be NULL.

Flags: Read / Write / Construct Only

Allowed values: GVariant<a{sv}>

Default value: NULL

Since 0.11.6


The “requests-satisfied” property

  “requests-satisfied”       GPtrArray *

A GPtrArray containing TpChannelRequest objects representing the requests that have been passed to HandleChannels. Read-only except during construction.

This property can't be NULL.

Flags: Read / Write / Construct Only

Since 0.11.6


The “user-action-time” property

  “user-action-time”         gint64

The time at which user action occurred, or one of the special values TP_USER_ACTION_TIME_NOT_USER_ACTION or TP_USER_ACTION_TIME_CURRENT_TIME (see “user-action-time” for details)

Read-only except during construction.

Flags: Read / Write / Construct Only

Allowed values: >= 0

Default value: 0

Since 0.11.6

Signal Details

The “done” signal

void
user_function (TpHandleChannelContext *self,
               gpointer                user_data)

Emitted when tp_handle_channel_context_accept has been called on self .

Parameters

self

a TpHandleChannelContext

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details

Since 0.11.6