Package telepathy :: Package server :: Module channel :: Class ChannelTypeRoomList
[hide private]
[frames] | no frames]

Class ChannelTypeRoomList

source code

                               object --+                
                                        |                
                   dbus.service.Interface --+            
                                            |            
                          dbus.service.Object --+        
                                                |        
                       _generated.Channel.Channel --+    
                                                    |    
                                              Channel --+
                                                        |
                                       object --+       |
                                                |       |
                           dbus.service.Interface --+   |
                                                    |   |
_generated.Channel_Type_Room_List.ChannelTypeRoomList --+
                                                        |
                                                       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]
 
__init__(self, connection)
Initialise the channel.
source code
 
GetListingRooms(self)
Check to see if there is already a room list request in progress on this channel.
source code
 
ListingRooms(self, *args, **keywords)
Emitted to indicate whether or not room listing request is currently in progress.

Inherited from Channel: Close, GetChannelType, GetHandle, GetInterfaces

Inherited from _generated.Channel.Channel: Closed

Inherited from dbus.service.Object: Introspect, __repr__, __str__, add_to_connection, remove_from_connection

Inherited from dbus.service.Object (private): _message_cb, _unregister_cb

Inherited from _generated.Channel_Type_Room_List.ChannelTypeRoomList: GotRooms, ListRooms, StopListing

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

Class Variables [hide private]
  __doc__ = _ChannelTypeRoomListIface.__doc__

Inherited from dbus.service.Object: SUPPORTS_MULTIPLE_CONNECTIONS, SUPPORTS_MULTIPLE_OBJECT_PATHS

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

Instance Variables [hide private]
Properties [hide private]

Inherited from dbus.service.Object: __dbus_object_path__, connection, locations

Inherited from object: __class__

Method Details [hide private]

__init__(self, connection)
(Constructor)

source code 

Initialise the channel.

Parameters: connection - the parent Telepathy Connection object

Overrides: Channel.__init__

GetListingRooms(self)

source code 
Check to see if there is already a room list request in progress on this channel.
Decorators:
  • @dbus.service.method(CHANNEL_TYPE_ROOM_LIST, in_signature= '', out_signature= 'b')
Overrides: _generated.Channel_Type_Room_List.ChannelTypeRoomList.GetListingRooms
(inherited documentation)

ListingRooms(self, *args, **keywords)

 
Emitted to indicate whether or not room listing request is currently in progress.
Decorators:
  • @dbus.service.signal(CHANNEL_TYPE_ROOM_LIST, signature= 'b')
Overrides: _generated.Channel_Type_Room_List.ChannelTypeRoomList.ListingRooms
(inherited documentation)