TelepathyGLib.RoomList¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.AsyncInitable (4)
Structs:: GObject.ObjectClass (5)

class	`new_async` (account, server, callback, *user_data)
class	`new_finish` (result)
	`get_account` ()
	`get_server` ()
	`is_listing` ()
	`start` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.AsyncInitable (2)

Properties¶

Name	Type	Flags	Short Description
`account`	`TelepathyGLib.Account`	r/w/co	`TelepathyGLib.Account`
`listing`	`bool`	r	`True` if the channel is listing rooms
`server`	`str`	r/w/co	The server associated with the channel

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`failed`	Fired when something goes wrong while listing the channels; see error for details.
`got-room`	Fired each time a room is found during the listing process.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class TelepathyGLib.RoomList(**kwargs)¶

Bases:: GObject.Object, Gio.AsyncInitable
Abstract:: No
Structure:: TelepathyGLib.RoomListClass

Data structure representing a TelepathyGLib.RoomList.

Added in version 0.19.0.

classmethod new_async(account, server, callback, *user_data)¶

Parameters:

account (TelepathyGLib.Account) – a TelepathyGLib.Account for the room listing
server (str) – the DNS name of the server whose rooms should listed
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the initialization is finished
user_data (object or None) – data to pass to the callback function

Added in version 0.19.0.

classmethod new_finish(result)¶

Parameters:: result (Gio.AsyncResult) – the Gio.AsyncResult from the callback
Raises:: GLib.Error
Returns:: a new TelepathyGLib.RoomList object, or None in case of error.
Return type:: TelepathyGLib.RoomList

Added in version 0.19.0.

get_account()¶

Returns:: the value of TelepathyGLib.RoomList :account property
Return type:: TelepathyGLib.Account

Return the TelepathyGLib.RoomList :account property

Added in version 0.19.0.

get_server()¶

Returns:: the value of TelepathyGLib.RoomList :server property
Return type:: str

Return the TelepathyGLib.RoomList :server property

Added in version 0.19.0.

is_listing()¶

Returns:: the value of TelepathyGLib.RoomList :listing property
Return type:: bool

Return the TelepathyGLib.RoomList :listing property

Added in version 0.19.0.

start()¶: Start listing rooms using self. Use the TelepathyGLib.RoomList ::got-rooms signal to get the rooms found. Errors will be reported using the TelepathyGLib.RoomList ::failed signal.

Added in version 0.19.0.

Signal Details¶

TelepathyGLib.RoomList.signals.failed(room_list, error)¶

Signal Name:

failed

Flags:

RUN_LAST

Parameters:

room_list (TelepathyGLib.RoomList) – The object which received the signal
error (GLib.Error) – a GLib.Error indicating the reason of the error

Fired when something goes wrong while listing the channels; see error for details.

Added in version 0.19.0.

TelepathyGLib.RoomList.signals.got_room(room_list, room)¶

Signal Name:

got-room

Flags:

RUN_LAST

Parameters:

room_list (TelepathyGLib.RoomList) – The object which received the signal
room (TelepathyGLib.RoomInfo) – a TelepathyGLib.RoomInfo

Fired each time a room is found during the listing process. User should take his own reference on room if he plans to continue using it once the signal callback has returned.

Added in version 0.19.0.

Property Details¶

TelepathyGLib.RoomList.props.account¶

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

The TelepathyGLib.Account to use for the room listing.

Added in version 0.19.0.

TelepathyGLib.RoomList.props.listing¶

Name:: listing
Type:: bool
Default Value:: False
Flags:: READABLE

True if the channel is currently listing rooms.

This property is meaningless until the %TP_ROOM_LIST_FEATURE_LISTING feature has been prepared.

Added in version 0.19.0.

TelepathyGLib.RoomList.props.server¶

Name:: server
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The DNS name of the server whose rooms are listed by this channel, or None.

Added in version 0.19.0.