ChannelRequest

Object Hierarchy:

Description:

[ CCode ( type_id = "tp_channel_request_get_type ()" ) ]
[ Version ( since = "0.7.32" ) ]
public class ChannelRequest : Proxy

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 succeeded signal will be emitted. Immediately after that, the invalidated signal will be emitted, with the domain TP_DBUS_ERRORS and the error code OBJECT_REMOVED (this is not an error condition, it merely indicates that the channel request no longer exists).

On failure, the invalidated signal will be emitted with some other suitable error, usually from the Error domain.

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

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

Since 0.16, ChannelRequest always has a non-%NULL factory, and its factory will be propagated to the Account, Connection and Channel.

Namespace: TelepathyGLib

Package: telepathy-glib

Content:

Properties:

public Account account { get; }
The Account on which this request was made, not guaranteed to be prepared.
public Object channel_factory { owned get; set construct; }
The object implementing the TpClientChannelFactoryInterface interface that will be used to create channel proxies when the succeeded_with_channel signal is fired.
public Variant hints_vardict { owned get; }
A VARDICT of metadata provided by the channel requester; or null if TpChannelRequest:immutable-propertiess is not defined or if no hints have been defined.
public Variant immutable_properties_vardict { owned get; }
The immutable D-Bus properties of this channel request, represented by a VARDICT where the keys are D-Bus interface name + ".
public string preferred_handler { get; }
Either the well-known bus name (starting with CLIENT_BUS_NAME_BASE) of the preferred handler for this channel request, or null to indicate that any handler would be acceptable.
public int64 user_action_time { get; }
The time at which user action occurred, or USER_ACTION_TIME_NOT_USER_ACTION if this channel request is for some reason not involving user action.

Static methods:

public static void init_known_interfaces ()
Ensure that the known interfaces for TpChannelRequest have been set up.

Creation methods:

public ChannelRequest (DBusDaemon bus_daemon, string object_path, HashTable<void*,void*> immutable_properties) throws Error
Convenience function to create a new channel request proxy.

Methods:

public Variant dup_hints ()
Return the hints_vardict property
public Variant dup_immutable_properties ()
Return the immutable_properties_vardict property.
public unowned Account get_account ()
Return the value of the account construct-only property
public unowned HashTable<void*,void*> get_hints ()
Return the TpChannelRequest:hintss property
public unowned HashTable<void*,void*> get_immutable_properties ()
Return the TpChannelRequest:immutable-propertiess construct-only property
public unowned string get_preferred_handler ()
return the preferred_handler construct-only property
public int64 get_user_action_time ()
return the user_action_time construct-only property
public void set_channel_factory (ClientChannelFactory factory)
Change the value of the channel_factory property.

Signals:

public signal void succeeded ()
Emitted when the channel request succeeds.
public signal void succeeded_with_channel (Connection connection, Channel channel)
Emitted when the channel request succeeds.

Inherited Members:

All known members inherited from class TelepathyGLib.Proxy

All known members inherited from class GLib.Object