TelepathyGLib.DBusTubeChannel

g GObject.Object GObject.Object TelepathyGLib.Proxy TelepathyGLib.Proxy GObject.Object->TelepathyGLib.Proxy TelepathyGLib.Channel TelepathyGLib.Channel TelepathyGLib.DBusTubeChannel TelepathyGLib.DBusTubeChannel TelepathyGLib.Channel->TelepathyGLib.DBusTubeChannel TelepathyGLib.Proxy->TelepathyGLib.Channel

Subclasses:

None

Methods

Inherited:

TelepathyGLib.Channel (44), TelepathyGLib.Proxy (11), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

feature_quark_core ()

accept_async (callback, *user_data)

accept_finish (result)

dup_parameters_vardict ()

get_service_name ()

offer_async (params, callback, *user_data)

offer_finish (result)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

TelepathyGLib.Channel (12), TelepathyGLib.Proxy (5)

Name

Type

Flags

Short Description

parameters-vardict

GLib.Variant

r

The parameters of the D-Bus tube

service-name

str

r

The service name of the dbus tube

Signals

Inherited:

TelepathyGLib.Channel (5), TelepathyGLib.Proxy (2), GObject.Object (1)

Fields

Inherited:

TelepathyGLib.Channel (5), TelepathyGLib.Proxy (2), GObject.Object (1)

Name

Type

Access

Description

parent

TelepathyGLib.Channel

r

Class Details

class TelepathyGLib.DBusTubeChannel(**kwargs)
Bases:

TelepathyGLib.Channel

Abstract:

No

Structure:

TelepathyGLib.DBusTubeChannelClass

Data structure representing a TelepathyGLib.DBusTubeChannel.

New in version 0.18.0.

classmethod feature_quark_core()
Return type:

int

accept_async(callback, *user_data)
Parameters:

Accept an incoming D-Bus tube. When the tube has been accepted callback will be called. You can then call TelepathyGLib.DBusTubeChannel.accept_finish() to get the Gio.DBusConnection that will be used to communicate through the tube.

New in version 0.18.0.

accept_finish(result)
Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

a reference on a Gio.DBusConnection if the tube has been successfully accepted and opened; None otherwise.

Return type:

Gio.DBusConnection

Finishes to accept an incoming D-Bus tube. The returned Gio.DBusConnection is ready to be used to exchange data through the tube.

New in version 0.18.0.

dup_parameters_vardict()
Returns:

a new reference to a GLib.Variant

Return type:

GLib.Variant

Return the parameters of the dbus-tube channel in a variant of type %G_VARIANT_TYPE_VARDICT whose keys are strings representing parameter names and values are variants representing corresponding parameter values set by the offerer when offering this channel.

The GLib.Variant returned is None if this is an outgoing tube that has not yet been offered or the parameters property has not been set.

Use g_variant_lookup(), GLib.Variant.lookup_value(), or tp_vardict_get_uint32() and similar functions for convenient access to the values.

New in version 0.19.10.

get_service_name()
Returns:

the value of TelepathyGLib.DBusTubeChannel :service-name

Return type:

str

Return the TelepathyGLib.DBusTubeChannel :service-name property

New in version 0.18.0.

offer_async(params, callback, *user_data)
Parameters:

Offer an outgoing D-Bus tube. When the tube has been offered and accepted callback will be called. You can then call TelepathyGLib.DBusTubeChannel.offer_finish() to get the Gio.DBusConnection that will be used to communicate through the tube.

New in version 0.18.0.

offer_finish(result)
Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

a reference on a Gio.DBusConnection if the tube has been successfully offered and opened; None otherwise.

Return type:

Gio.DBusConnection

Finishes offering an outgoing D-Bus tube. The returned Gio.DBusConnection is ready to be used to exchange data through the tube.

New in version 0.18.0.

Property Details

TelepathyGLib.DBusTubeChannel.props.parameters_vardict
Name:

parameters-vardict

Type:

GLib.Variant

Default Value:

None

Flags:

READABLE

A %G_VARIANT_TYPE_VARDICT representing the parameters of the tube.

Will be None for outgoing tubes until the tube has been offered.

New in version 0.19.10.

TelepathyGLib.DBusTubeChannel.props.service_name
Name:

service-name

Type:

str

Default Value:

None

Flags:

READABLE

A string representing the service name that will be used over the tube.

New in version 0.18.0.