Package telepathy :: Package _generated :: Module Channel_Type_Room_List :: Class ChannelTypeRoomList

Class ChannelTypeRoomList

            object --+    
                     |    
dbus.service.Interface --+
                         |
                        ChannelTypeRoomList

Known Subclasses:: server.channel.ChannelTypeRoomList

A channel type for listing named channels available on the server. Once the ListRooms method is called, it emits signals for rooms present on the server, until you Close this channel. In some cases, it may not be possible to stop the deluge of information from the server. This channel should be closed when the room information is no longer being displayed, so that the room handles can be freed.

This channel type may be implemented as a singleton on some protocols, so clients should be prepared for the eventuality that they are given a channel that is already in the middle of listing channels. The ListingRooms signal, or GetListingRooms method, can be used to check this.

Nested Classes

[hide private]

Inherited from dbus.service.Interface: __metaclass__

Instance Methods

[hide private]

GetListingRooms(self)
Check to see if there is already a room list request in progress on this channel.

source code

ListRooms(self)
Request the list of rooms from the server.

source code

StopListing(self)
Stop the room listing if it's in progress, but don't close the channel.

source code

GotRooms(self, *args, **keywords)
Emitted when information about rooms on the server becomes available.

ListingRooms(self, *args, **keywords)
Emitted to indicate whether or not room listing request is currently in progress.

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from dbus.service.Interface (private): _dbus_class_table

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

GetListingRooms(self)

source code

Check to see if there is already a room list request in progress on this channel.

Decorators:

@dbus.service.method('org.freedesktop.Telepathy.Channel.Type.RoomList', in_signature= '', out_signature= 'b')

ListRooms(self)

source code

Request the list of rooms from the server. The ListingRooms signal should be emitted when this request is being processed, GotRooms when any room information is received, and ListingRooms when the request is complete.

Decorators:

@dbus.service.method('org.freedesktop.Telepathy.Channel.Type.RoomList', in_signature= '', out_signature= '')

StopListing(self)

source code

Stop the room listing if it's in progress, but don't close the channel. The ListingRooms signal should be emitted when the listing stops.

Decorators:

@dbus.service.method('org.freedesktop.Telepathy.Channel.Type.RoomList', in_signature= '', out_signature= '')

GotRooms(self, *args, **keywords)

Emitted when information about rooms on the server becomes available. The array contains the room handle (as can be passed to the RequestChannel method with HANDLE_TYPE_ROOM), the channel type, and a dictionary containing further information about the room as available. The following well-known keys and types are recommended for use where appropriate:

s:handle-nameThe string name of the room handle (as would be returned by InspectHandles) s:nameThe human-readable name of the room if different from the handle s:descriptionA description of the room's overall purpose s:subjectThe current subject of conversation in the room u:membersThe number of members of the room b:passwordTrue if the room requires a password to enter b:invite-onlyTrue if you cannot join the room, but must be invited

Decorators:

@dbus.service.signal('org.freedesktop.Telepathy.Channel.Type.RoomList', signature= 'a(usa{sv})')

ListingRooms(self, *args, **keywords)

Emitted to indicate whether or not room listing request is currently in progress.

Decorators:

@dbus.service.signal('org.freedesktop.Telepathy.Channel.Type.RoomList', signature= 'b')