|  |  |  | telepathy-glib API Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ||||
#include <telepathy-glib/telepathy-glib.h> struct TpRoomList; struct TpRoomListClass; void tp_room_list_new_async (TpAccount *account,const gchar *server,GAsyncReadyCallback callback,gpointer user_data); TpRoomList * tp_room_list_new_finish (GAsyncResult *result,GError **error); gboolean tp_room_list_is_listing (TpRoomList *self); const gchar * tp_room_list_get_server (TpRoomList *self); TpAccount * tp_room_list_get_account (TpRoomList *self); void tp_room_list_start (TpRoomList *self);
"account" TpAccount* : Read / Write / Construct Only "listing" gboolean : Read "server" gchar* : Read / Write / Construct Only
void tp_room_list_new_async (TpAccount *account,const gchar *server,GAsyncReadyCallback callback,gpointer user_data);
| 
 | a TpAccount for the room listing | 
| 
 | the DNS name of the server whose rooms should listed | 
| 
 | a GAsyncReadyCallback to call when the initialization is finished | 
| 
 | data to pass to the callback function | 
Since 0.19.0
TpRoomList * tp_room_list_new_finish (GAsyncResult *result,GError **error);
| 
 | the GAsyncResult from the callback | 
| 
 | a GError location to store an error, or NULL | 
| Returns : | a new TpRoomList object, or NULLin case of error. [transfer full] | 
Since 0.19.0
gboolean            tp_room_list_is_listing             (TpRoomList *self);
Return the "listing" property
| 
 | a TpRoomList | 
| Returns : | the value of "listing" property | 
Since 0.19.0
const gchar *       tp_room_list_get_server             (TpRoomList *self);
Return the "server" property
| 
 | a TpRoomList | 
| Returns : | the value of "server" property | 
Since 0.19.0
TpAccount *         tp_room_list_get_account            (TpRoomList *self);
Return the "account" property
| 
 | a TpRoomList | 
| Returns : | the value of "account" property. [transfer none] | 
Since 0.19.0
void                tp_room_list_start                  (TpRoomList *self);
Start listing rooms using self. Use the TpRoomList::got-rooms
signal to get the rooms found.
Errors will be reported using the TpRoomList::failed signal.
| 
 | a TpRoomList | 
Since 0.19.0
"account" property"account" TpAccount* : Read / Write / Construct Only
The TpAccount to use for the room listing.
Since 0.19.0
"listing" property"listing" gboolean : Read
TRUE if the channel is currently listing rooms.
This property is meaningless until the
TP_ROOM_LIST_FEATURE_LISTING feature has been prepared.
Default value: FALSE
Since 0.19.0
"failed" signalvoid                user_function                      (TpRoomList *self,
                                                        GError     *error,
                                                        gpointer    user_data)      : Run Last
Fired when something goes wrong while listing the channels; see error
for details.
| 
 | a TpRoomList | 
| 
 | a GError indicating the reason of the error | 
| 
 | user data set when the signal handler was connected. | 
Since 0.19.0
"got-room" signalvoid                user_function                      (TpRoomList *self,
                                                        TpRoomInfo *room,
                                                        gpointer    user_data)      : Run Last
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.
| 
 | a TpRoomList | 
| 
 | a TpRoomInfo | 
| 
 | user data set when the signal handler was connected. | 
Since 0.19.0