Interface
PurpleProtocolChat
Description [src]
interface Purple.ProtocolChat : Purple.Protocol
PurpleProtocolChat
describes the API that protocols need to implement for
handling multiple user conversations.
Available since: | 3.0.0 |
Prerequisite
In order to implement ProtocolChat, your type must inherit from
PurpleProtocol
.
Instance methods
purple_protocol_chat_info
Gets the list of PurpleProtocolChatEntry
‘s that are required to join a
multi user chat.
Available since: 3.0.0
purple_protocol_chat_info_defaults
Returns a GHashTable
of the default protocol dependent components that will
be passed to purple_protocol_chat_join().
Available since: 3.0.0
purple_protocol_chat_set_topic
Sets the topic for the chat with id id
to topic
.
Available since: 3.0.0
Interface structure
struct PurpleProtocolChatInterface {
GList* (* info) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection
);
GHashTable* (* info_defaults) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
const gchar* chat_name
);
void (* join) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
GHashTable* components
);
void (* reject) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
GHashTable* components
);
gchar* (* get_name) (
PurpleProtocolChat* protocol_chat,
GHashTable* components
);
void (* invite) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
gint id,
const gchar* message,
const gchar* who
);
void (* leave) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
gint id
);
gint (* send) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
gint id,
PurpleMessage* message
);
gchar* (* get_user_real_name) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
gint id,
const gchar* who
);
void (* set_topic) (
PurpleProtocolChat* protocol_chat,
PurpleConnection* connection,
gint id,
const gchar* topic
);
}
Interface members
info |
|
No description available. | |
info_defaults |
|
No description available. | |
join |
|
No description available. | |
reject |
|
No description available. | |
get_name |
|
No description available. | |
invite |
|
No description available. | |
leave |
|
No description available. | |
send |
|
No description available. | |
get_user_real_name |
|
No description available. | |
set_topic |
|
No description available. |
Virtual methods
Purple.ProtocolChat.get_name
Gets the name from components
.
Purple.ProtocolChat.get_user_real_name
Gets the real name of who
.
Purple.ProtocolChat.info
Gets the list of PurpleProtocolChatEntry
‘s that are required to join a
multi user chat.
Purple.ProtocolChat.info_defaults
Returns a GHashTable
of the default protocol dependent components that will
be passed to purple_protocol_chat_join().
Purple.ProtocolChat.invite
Sends an invite to who
with message
.
Purple.ProtocolChat.join
Joins the chat described in components
.
Purple.ProtocolChat.leave
Leaves the chat identified by id
.
Purple.ProtocolChat.reject
Used to reject a chat invite.
Purple.ProtocolChat.send
Sends message
to the chat identified by id
.
Purple.ProtocolChat.set_topic
Sets the topic for the chat with id id
to topic
.