ChannelDispatchOperation

Object Hierarchy:

Description:

[ CCode ( type_id = "tp_channel_dispatch_operation_get_type ()" ) ]
[ Version ( since = "0.7.32" ) ]
public class ChannelDispatchOperation : Proxy

One of the channel dispatcher's functions is to offer incoming channels to Approver clients for approval.

An approver should generally ask the user whether they want to participate in the requested communication channels (join the chat or chatroom, answer the call, accept the file transfer, or whatever is appropriate). A collection of channels offered in this way is represented by a ChannelDispatchOperation object.

If the user wishes to accept the communication channels, the approver should call tp_cli_channel_dispatch_operation_call_handle_with to indicate the user's or approver's preferred handler for the channels (the empty string indicates no particular preference, and will cause any suitable handler to be used).

If the user wishes to reject the communication channels, or if the user accepts the channels and the approver will handle them itself, the approver should call tp_cli_channel_dispatch_operation_call_claim. If this method succeeds, the approver immediately has control over the channels as their primary handler, and may do anything with them (in particular, it may close them in whatever way seems most appropriate).

There are various situations in which the channel dispatch operation will be closed, causing the invalidated signal to be emitted. If this happens, the approver should stop prompting the user.

Because all approvers are launched simultaneously, the user might respond to another approver; if this happens, the invalidated signal will be emitted with the domain TP_DBUS_ERRORS and the error code OBJECT_REMOVED.

If a channel closes, the channel_lost signal is emitted. If all channels close, there is nothing more to dispatch, so the invalidated signal will be emitted with the domain TP_DBUS_ERRORS and the error code OBJECT_REMOVED.

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. In a high-quality implementation, the dispatcher should be restarted, at which point it will create new channel dispatch operations for any undispatched channels, and the approver will be notified again.

Creating a ChannelDispatchOperation directly is deprecated: it should only be created via a BaseClient.

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

Namespace: TelepathyGLib

Package: telepathy-glib

Content:

Properties:

public Account account { owned get; construct; }
The Account with which the connection and channels are associated.
public GenericArray<void*> channels { get; construct; }
A GenericArray containing the Channel to be dispatched.
public Connection connection { owned get; construct; }
The Connection with which the channels are associated.
public string[] possible_handlers { owned get; }
A GStrv containing the well known bus names (starting with TP_CLIENT_BUS_NAME_BASE) of the possible Handlers for the channels

Static methods:

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

Creation methods:

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

Methods:

public async bool claim_async () throws Error
Called by an approver to claim channels for handling internally.
public async bool claim_with_async (BaseClient client) throws Error
Called by an approver to claim channels for handling internally.
public async bool close_channels_async () throws Error
Called by an approver to claim channels and close them all right away.
public async bool destroy_channels_async () throws Error
Called by an approver to claim channels and destroy them all right away.
public unowned GenericArray<Channel> get_channels ()
Returns a GenericArray containing the Channel of this ChannelDispatchOperation.
public async bool handle_with_async (string? handler) throws Error
Called by an approver to accept a channel bundle and request that the given handler be used to handle it.
public async bool handle_with_time_async (string? handler, int64 user_action_time) throws Error
A variant of handle_with_async allowing the approver to pass an user action time.
public async bool leave_channels_async (ChannelGroupChangeReason reason, string message) throws Error
Called by an approver to claim channels and leave them all right away.

Signals:

public signal void channel_lost (Channel channel, uint domain, int code, string message)
Emitted when a channel has closed before it could be claimed or handled.

Inherited Members:

All known members inherited from class TelepathyGLib.Proxy

All known members inherited from class GLib.Object