Class

PurpleRoomlist

Description [src]

class Purple.Roomlist : GObject.Object {
  gparent: GObject
}

Represents a list of rooms for a given connection on a given protocol.

Ancestors

Constructors

purple_roomlist_new

Returns a newly created room list object.

Functions

purple_roomlist_get_list

Returns a PurpleRoomlist structure from the protocol, and instructs the protocol to start fetching the list.

purple_roomlist_get_ui_ops

Returns the purple window UI operations structure to be used in new windows.

purple_roomlist_set_ui_ops

Sets the UI operations structure to be used in all purple room lists.

purple_roomlist_show_with_account

This is used to get the room list on an account, asking the UI to pop up a dialog with the specified account already selected, and pretend the user clicked the get list button. While we’re pretending, predend I didn’t say anything about dialogs or buttons, since this is the core.

Instance methods

purple_roomlist_cancel_get_list

Tells the protocol to stop fetching the list. If this is possible and done, the protocol will call set_in_progress with FALSE and possibly unref the list if it took a reference.

purple_roomlist_get_account

Retrieve the PurpleAccount that was given when the room list was created.

purple_roomlist_get_in_progress

Gets the “in progress” state of the room list.

purple_roomlist_join_room

Create a new conversation for room.

Available since: 3.0.0

purple_roomlist_room_add

Adds a room to the list of them.

purple_roomlist_set_fields

Set the different field types and their names for this protocol.

purple_roomlist_set_in_progress

Set the “in progress” state of the room list.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Roomlist:account
No description available.
Purple.Roomlist:in-progress
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PurpleRoomlistClass {
  GObjectClass parent_class;
  
}
Class members
parent_class
GObjectClass
  No description available.