Interface
PurpleProtocolClient
Description [src]
interface Purple.ProtocolClient : Purple.Protocol
PurpleProtocolClient
interface defines the behavior of a typical chat
service’s client interface.
Prerequisite
In order to implement ProtocolClient, your type must inherit from
PurpleProtocol
.
Instance methods
purple_protocol_client_blist_node_menu
Gets a list of PurpleActionMenu
structs, which represent extra actions to
be shown in (for example) the right-click menu for node
.
Available since: 3.0.0
purple_protocol_client_buddy_free
Cleans up any protocol specific data for buddy
.
Available since: 3.0.0
purple_protocol_client_convo_closed
Closes the conversation named who
on connection connection
.
Available since: 3.0.0
purple_protocol_client_find_blist_chat
Looks for a chat named name
in the contact list of account
.
Available since: 3.0.0
purple_protocol_client_get_account_text_table
Gets the account text table which allows protocols to specify additional strings to be used for various purposes. The idea is to stuff a bunch of strings in this hash table instead of expanding the struct for every addition.
Available since: 3.0.0
Deprecated since: 3.0.0
purple_protocol_client_get_max_message_size
Gets the maximum number of characters per message for conv
.
Available since: 3.0.0
purple_protocol_client_list_emblem
Gets the icon name of the emblem that should be used for buddy
.
Available since: 3.0.0
purple_protocol_client_normalize
Normalizes a who
to the canonical form for the protocol. For example, many
protocols only support all lower case, but might have display version where
there are capital letters.
Available since: 3.0.0
Deprecated since: 3.0.0
purple_protocol_client_offline_message
Checks whether offline messages to buddy
are supported.
Available since: 3.0.0
purple_protocol_client_tooltip_text
Asks client
to update user_info
for buddy
. If full
is TRUE
then
more detailed information will added.
Available since: 3.0.0
Interface structure
struct PurpleProtocolClientInterface {
const gchar* (* list_emblem) (
PurpleProtocolClient* client,
PurpleBuddy* buddy
);
gchar* (* status_text) (
PurpleProtocolClient* client,
PurpleBuddy* buddy
);
void (* tooltip_text) (
PurpleProtocolClient* client,
PurpleBuddy* buddy,
PurpleNotifyUserInfo* user_info,
gboolean full
);
GList* (* blist_node_menu) (
PurpleProtocolClient* client,
PurpleBlistNode* node
);
void (* buddy_free) (
PurpleProtocolClient* client,
PurpleBuddy* buddy
);
void (* convo_closed) (
PurpleProtocolClient* client,
PurpleConnection* connection,
const gchar* who
);
const gchar* (* normalize) (
PurpleProtocolClient* client,
PurpleAccount* account,
const gchar* who
);
PurpleChat* (* find_blist_chat) (
PurpleProtocolClient* client,
PurpleAccount* account,
const gchar* name
);
gboolean (* offline_message) (
PurpleProtocolClient* client,
PurpleBuddy* buddy
);
GHashTable* (* get_account_text_table) (
PurpleProtocolClient* client,
PurpleAccount* account
);
PurpleMood* (* get_moods) (
PurpleProtocolClient* client,
PurpleAccount* account
);
gssize (* get_max_message_size) (
PurpleProtocolClient* client,
PurpleConversation* conv
);
}
Interface members
list_emblem |
|
No description available. | |
status_text |
|
No description available. | |
tooltip_text |
|
No description available. | |
blist_node_menu |
|
No description available. | |
buddy_free |
|
No description available. | |
convo_closed |
|
No description available. | |
normalize |
|
No description available. | |
find_blist_chat |
|
No description available. | |
offline_message |
|
No description available. | |
get_account_text_table |
|
No description available. | |
get_moods |
|
No description available. | |
get_max_message_size |
|
No description available. |
Virtual methods
Purple.ProtocolClient.blist_node_menu
Gets a list of PurpleActionMenu
structs, which represent extra actions to
be shown in (for example) the right-click menu for node
.
Purple.ProtocolClient.buddy_free
Cleans up any protocol specific data for buddy
.
Purple.ProtocolClient.convo_closed
Closes the conversation named who
on connection connection
.
Purple.ProtocolClient.find_blist_chat
Looks for a chat named name
in the contact list of account
.
Purple.ProtocolClient.get_account_text_table
Gets the account text table which allows protocols to specify additional strings to be used for various purposes. The idea is to stuff a bunch of strings in this hash table instead of expanding the struct for every addition.
Deprecated since:
Purple.ProtocolClient.get_max_message_size
Gets the maximum number of characters per message for conv
.
Purple.ProtocolClient.get_moods
Gets the mood’s for account
.
Purple.ProtocolClient.list_emblem
Gets the icon name of the emblem that should be used for buddy
.
Purple.ProtocolClient.normalize
Normalizes a who
to the canonical form for the protocol. For example, many
protocols only support all lower case, but might have display version where
there are capital letters.
Deprecated since:
Purple.ProtocolClient.offline_message
Checks whether offline messages to buddy
are supported.
Purple.ProtocolClient.status_text
Gets the status text for buddy
.
Purple.ProtocolClient.tooltip_text
Asks client
to update user_info
for buddy
. If full
is TRUE
then
more detailed information will added.