TelepathyGLib.HandleChannelsContext

g GObject.Object GObject.Object TelepathyGLib.HandleChannelsContext TelepathyGLib.HandleChannelsContext GObject.Object->TelepathyGLib.HandleChannelsContext

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

accept ()

delay ()

fail (error)

get_handler_info ()

get_requests ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

account

TelepathyGLib.Account

r/w/co

The TelepathyGLib.Account of the context

channels

GLib.PtrArray

r/w/co

The TpChannels that have been passed to HandleChannels

connection

TelepathyGLib.Connection

r/w/co

The TelepathyGLib.Connection of the context

requests-satisfied

GLib.PtrArray

r/w/co

The TelepathyGLib.ChannelRequest that has been passed to HandleChannels

user-action-time

int

r/w/co

The User_Action_Time that has been passed to HandleChannels

Signals

Inherited:

GObject.Object (1)

Name

Short Description

done

Emitted when TelepathyGLib.HandleChannelsContext.accept has been called on self.

Fields

Inherited:

GObject.Object (1)

Class Details

class TelepathyGLib.HandleChannelsContext(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

TelepathyGLib.HandleChannelsContextClass

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

New in version 0.11.6.

accept()

Called by TelepathyGLib.BaseClientClassAddDispatchOperationImpl 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.

New in version 0.11.6.

delay()

Called by TelepathyGLib.BaseClientClassAddDispatchOperationImpl to indicate that it implements the method in an async way. The caller must take a reference to the TelepathyGLib.HandleChannelsContext before calling this function, and is responsible for calling either TelepathyGLib.HandleChannelsContext.accept() or TelepathyGLib.HandleChannelsContext.fail() later.

New in version 0.11.6.

fail(error)
Parameters:

error (GLib.Error) – the error to return from the method

Called by TelepathyGLib.BaseClientClassAddDispatchOperationImpl to raise a D-Bus error.

New in version 0.11.6.

get_handler_info()
Returns:

extensible extra handler information, in a form suitable for use with TelepathyGLib.asv_get_string() etc.

Return type:

{str: GObject.Value}

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.

The returned hash table is only valid for as long as self is.

New in version 0.11.14.

get_requests()
Returns:

a newly allocated GLib.List of reffed TelepathyGLib.ChannelRequest.

Return type:

[TelepathyGLib.ChannelRequest]

Return a list of the TelepathyGLib.ChannelRequest which have been satisfied by the channels associated with #self.

New in version 0.13.14.

Signal Details

TelepathyGLib.HandleChannelsContext.signals.done(handle_channels_context)
Signal Name:

done

Flags:

RUN_LAST, DETAILED

Parameters:

handle_channels_context (TelepathyGLib.HandleChannelsContext) – The object which received the signal

Emitted when TelepathyGLib.HandleChannelsContext.accept has been called on self.

New in version 0.11.6.

Property Details

TelepathyGLib.HandleChannelsContext.props.account
Name:

account

Type:

TelepathyGLib.Account

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

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

This property can’t be None.

New in version 0.11.6.

TelepathyGLib.HandleChannelsContext.props.channels
Name:

channels

Type:

GLib.PtrArray

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

A GLib.PtrArray containing TelepathyGLib.Channel objects representing the channels that have been passed to HandleChannels. Read-only except during construction.

This property can’t be None.

New in version 0.11.6.

TelepathyGLib.HandleChannelsContext.props.connection
Name:

connection

Type:

TelepathyGLib.Connection

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

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

This property can’t be None.

New in version 0.11.6.

TelepathyGLib.HandleChannelsContext.props.requests_satisfied
Name:

requests-satisfied

Type:

GLib.PtrArray

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

A GLib.PtrArray containing TelepathyGLib.ChannelRequest objects representing the requests that have been passed to HandleChannels. Read-only except during construction.

This property can’t be None.

New in version 0.11.6.

TelepathyGLib.HandleChannelsContext.props.user_action_time
Name:

user-action-time

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The time at which user action occurred, or one of the special values TelepathyGLib.USER_ACTION_TIME_NOT_USER_ACTION or %TP_USER_ACTION_TIME_CURRENT_TIME (see TelepathyGLib.AccountChannelRequest :user-action-time for details)

Read-only except during construction.

New in version 0.11.6.