TelepathyGLib.ChannelRequest¶

Subclasses:: None

Methods¶

Inherited:: TelepathyGLib.Proxy (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`init_known_interfaces` ()
class	`new` (bus_daemon, object_path, immutable_properties)
	`dup_hints` ()
	`dup_immutable_properties` ()
	`get_account` ()
	`get_hints` ()
	`get_immutable_properties` ()
	`get_preferred_handler` ()
	`get_user_action_time` ()
	`set_channel_factory` (factory)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: TelepathyGLib.Proxy (5)

Name	Type	Flags	Short Description
`account`	`TelepathyGLib.Account`	r	Account
`channel-factory`	`GObject.Object`	r/w/c	Object implementing `TelepathyGLib.ClientChannelFactoryInterface` `deprecated`
`hints-vardict`	`GLib.Variant`	r	Hints
`immutable-properties-vardict`	`GLib.Variant`	r	A map D-Bus interface + “.” + property name => variant
`preferred-handler`	`str`	r	PreferredHandler
`user-action-time`	`int`	r	UserActionTime

Signals¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Short Description
`succeeded`	Emitted when the channel request succeeds. `deprecated`
`succeeded-with-channel`	Emitted when the channel request succeeds.

Fields¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Type	Access	Description
parent	`TelepathyGLib.Proxy`	r

Class Details¶

class TelepathyGLib.ChannelRequest(**kwargs)¶

Bases:: TelepathyGLib.Proxy
Abstract:: No
Structure:: TelepathyGLib.ChannelRequestClass

Requesting a channel from the channel dispatcher can take some time, so an object is created in the channel dispatcher to represent each request. This proxy represents one of those objects.

Any client can call tp_cli_channel_request_call_cancel() at any time to attempt to cancel the request.

On success, the TelepathyGLib.ChannelRequest ::succeeded signal will be emitted. Immediately after that, the TelepathyGLib.Proxy ::invalidated signal will be emitted, with the domain %TP_DBUS_ERRORS and the error code TelepathyGLib.DBusError.OBJECT_REMOVED (this is not an error condition, it merely indicates that the channel request no longer exists).

On failure, the TelepathyGLib.Proxy ::invalidated signal will be emitted with some other suitable error, usually from the %TP_ERROR domain.

If the channel dispatcher crashes or exits, the TelepathyGLib.Proxy ::invalidated signal will be emitted with the domain %TP_DBUS_ERRORS and the error code TelepathyGLib.DBusError.NAME_OWNER_LOST.

Creating a TelepathyGLib.ChannelRequest directly is deprecated: it should only be created via a TelepathyGLib.AccountChannelRequest or a TelepathyGLib.BaseClient.

Since 0.16, TelepathyGLib.ChannelRequest always has a non-None TelepathyGLib.Proxy :factory, and its TelepathyGLib.Proxy :factory will be propagated to the TelepathyGLib.Account, TelepathyGLib.Connection and TelepathyGLib.Channel.

New in version 0.7.32.

classmethod init_known_interfaces()¶: Ensure that the known interfaces for TelepathyGLib.ChannelRequest have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument %TP_TYPE_CHANNEL_REQUEST.

New in version 0.7.32.

classmethod new(bus_daemon, object_path, immutable_properties)¶

Parameters:

bus_daemon (TelepathyGLib.DBusDaemon) – Proxy for the D-Bus daemon
object_path (str) – The non-None object path of this channel request
immutable_properties ({object: object}) – As many as are known of the immutable D-Bus properties of this channel request, or None if none are known

Raises:

GLib.Error

Returns:

a new reference to an channel request proxy, or None if object_path is not syntactically valid or the channel dispatcher is not running

Return type:

TelepathyGLib.ChannelRequest

Convenience function to create a new channel request proxy.

If the channel request was newly created, the client making the request is responsible for calling tp_cli_channel_request_call_proceed() when it is ready for the channel request to proceed.

Deprecated since version 0.19.9: New code should get TelepathyGLib.ChannelRequest objects from a TelepathyGLib.BaseClient

dup_hints()¶

Returns:: the value of TelepathyGLib.ChannelRequest :hints-vardict
Return type:: GLib.Variant

Return the TelepathyGLib.ChannelRequest :hints-vardict property

New in version 0.19.10.

dup_immutable_properties()¶

Returns:: the value of TelepathyGLib.ChannelRequest :immutable-properties-vardict
Return type:: GLib.Variant

Return the TelepathyGLib.ChannelRequest :immutable-properties-vardict property.

New in version 0.19.10.

get_account()¶

Returns:: the value of TelepathyGLib.ChannelRequest :account
Return type:: TelepathyGLib.Account

Return the value of the TelepathyGLib.ChannelRequest :account construct-only property

New in version 0.15.3.

get_hints()¶

Returns:: the value of TelepathyGLib.ChannelRequest :hints
Return type:: {object: object}

Return the TelepathyGLib.ChannelRequest :hints property

New in version 0.13.14.

get_immutable_properties()¶

Returns:: the value of TelepathyGLib.ChannelRequest :immutable-properties
Return type:: {object: object}

Return the TelepathyGLib.ChannelRequest :immutable-properties construct-only property

New in version 0.13.14.

get_preferred_handler()¶

Returns:: the value of TelepathyGLib.ChannelRequest :preferred-handler
Return type:: str

return the TelepathyGLib.ChannelRequest :preferred-handler construct-only property

New in version 0.15.3.

get_user_action_time()¶

Returns:: the value of TelepathyGLib.ChannelRequest :user-action-time
Return type:: int

return the TelepathyGLib.ChannelRequest :user-action-time construct-only property

New in version 0.15.3.

set_channel_factory(factory)¶

Parameters:: factory (TelepathyGLib.ClientChannelFactory) – an object implementing the TelepathyGLib.ClientChannelFactoryInterface interface

Change the value of the TelepathyGLib.ChannelRequest :channel-factory property.

New in version 0.13.14.

Deprecated since version ???: since 0.15.5. Use TelepathyGLib.Proxy :factory instead.

Signal Details¶

TelepathyGLib.ChannelRequest.signals.succeeded(channel_request)¶

Signal Name:: succeeded
Flags:: RUN_LAST, DETAILED
Parameters:: channel_request (TelepathyGLib.ChannelRequest) – The object which received the signal

Emitted when the channel request succeeds.

Deprecated since version ???: since 0.13.14. Use TelepathyGLib.ChannelRequest ::succeeded-with-channel, which provides the resulting channel, instead.

TelepathyGLib.ChannelRequest.signals.succeeded_with_channel(channel_request, connection, channel)¶

Signal Name:

succeeded-with-channel

Flags:

RUN_LAST, DETAILED

Parameters:

channel_request (TelepathyGLib.ChannelRequest) – The object which received the signal
connection (TelepathyGLib.Connection) – the TelepathyGLib.Connection of channel, or None
channel (TelepathyGLib.Channel) – the TelepathyGLib.Channel created, or None

Emitted when the channel request succeeds.

With telepathy-mission-control version 5.7.1 and earlier, connection and channel will be None. When using newer versions, they will be correctly set to the newly-created channel, and the connection which owns it.

The TelepathyGLib.Channel is created using TelepathyGLib.ChannelRequest :channel-factory or TelepathyGLib.Proxy :factory but the features of the factory are NOT prepared. It’s up to the user to prepare the features returned by TelepathyGLib.SimpleClientFactory.dup_channel_features() himself.

New in version 0.13.14.

Property Details¶

TelepathyGLib.ChannelRequest.props.account¶

Name:: account
Type:: TelepathyGLib.Account
Default Value:: None
Flags:: READABLE

The TelepathyGLib.Account on which this request was made, not guaranteed to be prepared.

Read-only.

New in version 0.15.3.

TelepathyGLib.ChannelRequest.props.channel_factory¶

Name:: channel-factory
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

The object implementing the TelepathyGLib.ClientChannelFactoryInterface interface that will be used to create channel proxies when the TelepathyGLib.ChannelRequest ::succeeded-with-channel signal is fired. This property can be changed using TelepathyGLib.ChannelRequest.set_channel_factory().

If no channel factory is specified then TelepathyGLib.AutomaticProxyFactory is used.

New in version 0.13.14.

Deprecated since version ???: since 0.15.5. Use TelepathyGLib.Proxy :factory instead.

TelepathyGLib.ChannelRequest.props.hints_vardict¶

Name:: hints-vardict
Type:: GLib.Variant
Default Value:: None
Flags:: READABLE

A %G_VARIANT_TYPE_VARDICT of metadata provided by the channel requester; or None if TelepathyGLib.ChannelRequest :immutable-properties is not defined or if no hints have been defined.

Read-only.

New in version 0.19.10.

TelepathyGLib.ChannelRequest.props.immutable_properties_vardict¶

Name:: immutable-properties-vardict
Type:: GLib.Variant
Default Value:: None
Flags:: READABLE

The immutable D-Bus properties of this channel request, represented by a %G_VARIANT_TYPE_VARDICT where the keys are D-Bus interface name + “.” + property name.

Note that this property is set only if the immutable properties have been set during the construction of the TelepathyGLib.ChannelRequest.

Read-only except during construction.

New in version 0.19.10.

TelepathyGLib.ChannelRequest.props.preferred_handler¶

Name:: preferred-handler
Type:: str
Default Value:: None
Flags:: READABLE

Either the well-known bus name (starting with TelepathyGLib.CLIENT_BUS_NAME_BASE) of the preferred handler for this channel request, or None to indicate that any handler would be acceptable.

Read-only.

New in version 0.15.3.

TelepathyGLib.ChannelRequest.props.user_action_time¶

Name:: user-action-time
Type:: int
Default Value:: 0
Flags:: READABLE

The time at which user action occurred, or TelepathyGLib.USER_ACTION_TIME_NOT_USER_ACTION if this channel request is for some reason not involving user action.

Read-only.

New in version 0.15.3.