Interface

PurpleProtocolRoomlist

Description [src]

interface Purple.ProtocolRoomlist : Purple.Protocol

PurpleProtocolRoomlist is an interface to abstract how to handle rooms lists at the protocol level.

Prerequisite

In order to implement ProtocolRoomlist, your type must inherit from PurpleProtocol.

Instance methods

purple_protocol_roomlist_cancel

Requesting a roomlist can take a long time. This function cancels a request that’s already in progress.

Available since: 3.0.0

purple_protocol_roomlist_expand_category

Expands the given category for list.

Available since: 3.0.0

purple_protocol_roomlist_get_list

Gets the list of rooms for gc.

Available since: 3.0.0

purple_protocol_roomlist_room_serialize

Serializes room into a string that will be displayed in a user interface.

Available since: 3.0.0

Interface structure

struct PurpleProtocolRoomlistInterface {
  PurpleRoomlist* (* get_list) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleConnection* gc
  );
  void (* cancel) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlist* list
  );
  void (* expand_category) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlist* list,
    PurpleRoomlistRoom* category
  );
  gchar* (* room_serialize) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlistRoom* room
  );
  
}

The protocol roomlist interface.

This interface provides callbacks for room listing.

Interface members
get_list
PurpleRoomlist* (* get_list) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleConnection* gc
  )
 No description available.
cancel
void (* cancel) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlist* list
  )
 No description available.
expand_category
void (* expand_category) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlist* list,
    PurpleRoomlistRoom* category
  )
 No description available.
room_serialize
gchar* (* room_serialize) (
    PurpleProtocolRoomlist* protocol_roomlist,
    PurpleRoomlistRoom* room
  )
 No description available.

Virtual methods

Purple.ProtocolRoomlist.cancel

Requesting a roomlist can take a long time. This function cancels a request that’s already in progress.

Purple.ProtocolRoomlist.expand_category

Expands the given category for list.

Purple.ProtocolRoomlist.get_list

Gets the list of rooms for gc.

Purple.ProtocolRoomlist.room_serialize

Serializes room into a string that will be displayed in a user interface.