pidgin 2.14.14dev
|
Buddy List API. More...
#include <glib.h>
#include "account.h"
#include "buddyicon.h"
#include "media.h"
#include "status.h"
Go to the source code of this file.
Data Structures | |
struct | _PurpleBlistNode |
A Buddy list node. More... | |
struct | _PurpleBuddy |
A buddy. More... | |
struct | _PurpleContact |
A contact. More... | |
struct | _PurpleGroup |
A group. More... | |
struct | _PurpleChat |
A chat. More... | |
struct | _PurpleBuddyList |
The Buddy List. More... | |
struct | _PurpleBlistUiOps |
Buddy list UI operations. More... | |
Typedefs | |
typedef struct _PurpleBuddyList | PurpleBuddyList |
The Buddy List. | |
typedef struct _PurpleBlistUiOps | PurpleBlistUiOps |
Buddy list UI operations. | |
typedef struct _PurpleBlistNode | PurpleBlistNode |
A Buddy list node. | |
typedef struct _PurpleChat | PurpleChat |
A chat. | |
typedef struct _PurpleGroup | PurpleGroup |
A group. | |
typedef struct _PurpleContact | PurpleContact |
A contact. | |
typedef struct _PurpleBuddy | PurpleBuddy |
A buddy. | |
Enumerations | |
enum | PurpleBlistNodeType { PURPLE_BLIST_GROUP_NODE , PURPLE_BLIST_CONTACT_NODE , PURPLE_BLIST_BUDDY_NODE , PURPLE_BLIST_CHAT_NODE , PURPLE_BLIST_OTHER_NODE } |
enum | PurpleBlistNodeFlags { PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0 , PURPLE_BLIST_NODE_FLAG_INVISIBLE = 1 << 1 } |
Functions | |
Buddy List API <br> | |
PurpleBuddyList * | purple_blist_new (void) |
Creates a new buddy list. | |
void | purple_set_blist (PurpleBuddyList *blist) |
Sets the main buddy list. | |
PurpleBuddyList * | purple_get_blist (void) |
Returns the main buddy list. | |
PurpleBlistNode * | purple_blist_get_root (void) |
Returns the root node of the main buddy list. | |
GSList * | purple_blist_get_buddies (void) |
Returns a list of every buddy in the list. | |
gpointer | purple_blist_get_ui_data (void) |
Returns the UI data for the list. | |
void | purple_blist_set_ui_data (gpointer ui_data) |
Sets the UI data for the list. | |
PurpleBlistNode * | purple_blist_node_next (PurpleBlistNode *node, gboolean offline) |
Returns the next node of a given node. | |
PurpleBlistNode * | purple_blist_node_get_parent (PurpleBlistNode *node) |
Returns the parent node of a given node. | |
PurpleBlistNode * | purple_blist_node_get_first_child (PurpleBlistNode *node) |
Returns the the first child node of a given node. | |
PurpleBlistNode * | purple_blist_node_get_sibling_next (PurpleBlistNode *node) |
Returns the sibling node of a given node. | |
PurpleBlistNode * | purple_blist_node_get_sibling_prev (PurpleBlistNode *node) |
Returns the previous sibling node of a given node. | |
gpointer | purple_blist_node_get_ui_data (const PurpleBlistNode *node) |
Returns the UI data of a given node. | |
void | purple_blist_node_set_ui_data (PurpleBlistNode *node, gpointer ui_data) |
Sets the UI data of a given node. | |
void | purple_blist_show (void) |
Shows the buddy list, creating a new one if necessary. | |
void | purple_blist_destroy (void) |
Destroys the buddy list window. | |
void | purple_blist_set_visible (gboolean show) |
Hides or unhides the buddy list. | |
void | purple_blist_update_buddy_status (PurpleBuddy *buddy, PurpleStatus *old_status) |
Updates a buddy's status. | |
void | purple_blist_update_node_icon (PurpleBlistNode *node) |
Updates a node's custom icon. | |
void | purple_blist_update_buddy_icon (PurpleBuddy *buddy) |
Updates a buddy's icon. | |
void | purple_blist_rename_buddy (PurpleBuddy *buddy, const char *name) |
Renames a buddy in the buddy list. | |
void | purple_blist_alias_contact (PurpleContact *contact, const char *alias) |
Aliases a contact in the buddy list. | |
void | purple_blist_alias_buddy (PurpleBuddy *buddy, const char *alias) |
Aliases a buddy in the buddy list. | |
void | purple_blist_server_alias_buddy (PurpleBuddy *buddy, const char *alias) |
Sets the server-sent alias of a buddy in the buddy list. | |
void | purple_blist_alias_chat (PurpleChat *chat, const char *alias) |
Aliases a chat in the buddy list. | |
void | purple_blist_rename_group (PurpleGroup *group, const char *name) |
Renames a group. | |
PurpleChat * | purple_chat_new (PurpleAccount *account, const char *alias, GHashTable *components) |
Creates a new chat for the buddy list. | |
void | purple_chat_destroy (PurpleChat *chat) |
Destroys a chat. | |
void | purple_blist_add_chat (PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node) |
Adds a new chat to the buddy list. | |
PurpleBuddy * | purple_buddy_new (PurpleAccount *account, const char *name, const char *alias) |
Creates a new buddy. | |
void | purple_buddy_destroy (PurpleBuddy *buddy) |
Destroys a buddy. | |
void | purple_buddy_set_icon (PurpleBuddy *buddy, PurpleBuddyIcon *icon) |
Sets a buddy's icon. | |
PurpleAccount * | purple_buddy_get_account (const PurpleBuddy *buddy) |
Returns a buddy's account. | |
const char * | purple_buddy_get_name (const PurpleBuddy *buddy) |
Returns a buddy's name. | |
PurpleBuddyIcon * | purple_buddy_get_icon (const PurpleBuddy *buddy) |
Returns a buddy's icon. | |
gpointer | purple_buddy_get_protocol_data (const PurpleBuddy *buddy) |
Returns a buddy's protocol-specific data. | |
void | purple_buddy_set_protocol_data (PurpleBuddy *buddy, gpointer data) |
Sets a buddy's protocol-specific data. | |
PurpleContact * | purple_buddy_get_contact (PurpleBuddy *buddy) |
Returns a buddy's contact. | |
PurplePresence * | purple_buddy_get_presence (const PurpleBuddy *buddy) |
Returns a buddy's presence. | |
PurpleMediaCaps | purple_buddy_get_media_caps (const PurpleBuddy *buddy) |
Gets the media caps from a buddy. | |
void | purple_buddy_set_media_caps (PurpleBuddy *buddy, PurpleMediaCaps media_caps) |
Sets the media caps for a buddy. | |
void | purple_blist_add_buddy (PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node) |
Adds a new buddy to the buddy list. | |
PurpleGroup * | purple_group_new (const char *name) |
Creates a new group. | |
void | purple_group_destroy (PurpleGroup *group) |
Destroys a group. | |
void | purple_blist_add_group (PurpleGroup *group, PurpleBlistNode *node) |
Adds a new group to the buddy list. | |
PurpleContact * | purple_contact_new (void) |
Creates a new contact. | |
void | purple_contact_destroy (PurpleContact *contact) |
Destroys a contact. | |
PurpleGroup * | purple_contact_get_group (const PurpleContact *contact) |
Gets the PurpleGroup from a PurpleContact. | |
void | purple_blist_add_contact (PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node) |
Adds a new contact to the buddy list. | |
void | purple_blist_merge_contact (PurpleContact *source, PurpleBlistNode *node) |
Merges two contacts. | |
PurpleBuddy * | purple_contact_get_priority_buddy (PurpleContact *contact) |
Returns the highest priority buddy for a given contact. | |
void | purple_contact_set_alias (PurpleContact *contact, const char *alias) |
Sets the alias for a contact. | |
const char * | purple_contact_get_alias (PurpleContact *contact) |
Gets the alias for a contact. | |
gboolean | purple_contact_on_account (PurpleContact *contact, PurpleAccount *account) |
Determines whether an account owns any buddies in a given contact. | |
void | purple_contact_invalidate_priority_buddy (PurpleContact *contact) |
Invalidates the priority buddy so that the next call to purple_contact_get_priority_buddy recomputes it. | |
void | purple_blist_remove_buddy (PurpleBuddy *buddy) |
Removes a buddy from the buddy list and frees the memory allocated to it. | |
void | purple_blist_remove_contact (PurpleContact *contact) |
Removes a contact, and any buddies it contains, and frees the memory allocated to it. | |
void | purple_blist_remove_chat (PurpleChat *chat) |
Removes a chat from the buddy list and frees the memory allocated to it. | |
void | purple_blist_remove_group (PurpleGroup *group) |
Removes a group from the buddy list and frees the memory allocated to it and to its children. | |
const char * | purple_buddy_get_alias_only (PurpleBuddy *buddy) |
Returns the alias of a buddy. | |
const char * | purple_buddy_get_server_alias (PurpleBuddy *buddy) |
Gets the server alias for a buddy. | |
const char * | purple_buddy_get_contact_alias (PurpleBuddy *buddy) |
Returns the correct name to display for a buddy, taking the contact alias into account. | |
const char * | purple_buddy_get_local_alias (PurpleBuddy *buddy) |
Returns the correct alias for this user, ignoring server aliases. | |
const char * | purple_buddy_get_alias (PurpleBuddy *buddy) |
Returns the correct name to display for a buddy. | |
const char * | purple_buddy_get_local_buddy_alias (PurpleBuddy *buddy) |
Returns the local alias for the buddy, or NULL if none exists. | |
const char * | purple_chat_get_name (PurpleChat *chat) |
Returns the correct name to display for a blist chat. | |
PurpleBuddy * | purple_find_buddy (PurpleAccount *account, const char *name) |
Finds the buddy struct given a name and an account. | |
PurpleBuddy * | purple_find_buddy_in_group (PurpleAccount *account, const char *name, PurpleGroup *group) |
Finds the buddy struct given a name, an account, and a group. | |
GSList * | purple_find_buddies (PurpleAccount *account, const char *name) |
Finds all PurpleBuddy structs given a name and an account. | |
PurpleGroup * | purple_find_group (const char *name) |
Finds a group by name. | |
PurpleChat * | purple_blist_find_chat (PurpleAccount *account, const char *name) |
Finds a chat by name. | |
PurpleGroup * | purple_chat_get_group (PurpleChat *chat) |
Returns the group of which the chat is a member. | |
PurpleAccount * | purple_chat_get_account (PurpleChat *chat) |
Returns the account the chat belongs to. | |
GHashTable * | purple_chat_get_components (PurpleChat *chat) |
Get a hashtable containing information about a chat. | |
PurpleGroup * | purple_buddy_get_group (PurpleBuddy *buddy) |
Returns the group of which the buddy is a member. | |
GSList * | purple_group_get_accounts (PurpleGroup *g) |
Returns a list of accounts that have buddies in this group. | |
gboolean | purple_group_on_account (PurpleGroup *g, PurpleAccount *account) |
Determines whether an account owns any buddies in a given group. | |
const char * | purple_group_get_name (PurpleGroup *group) |
Returns the name of a group. | |
void | purple_blist_add_account (PurpleAccount *account) |
Called when an account connects. | |
void | purple_blist_remove_account (PurpleAccount *account) |
Called when an account disconnects. | |
int | purple_blist_get_group_size (PurpleGroup *group, gboolean offline) |
Determines the total size of a group. | |
int | purple_blist_get_group_online_count (PurpleGroup *group) |
Determines the number of online buddies in a group. | |
Buddy list file management API <br> | |
void | purple_blist_load (void) |
Loads the buddy list from ~/.purple/blist.xml. | |
void | purple_blist_schedule_save (void) |
Schedule a save of the blist.xml file. | |
void | purple_blist_request_add_buddy (PurpleAccount *account, const char *username, const char *group, const char *alias) |
Requests from the user information needed to add a buddy to the buddy list. | |
void | purple_blist_request_add_chat (PurpleAccount *account, PurpleGroup *group, const char *alias, const char *name) |
Requests from the user information needed to add a chat to the buddy list. | |
void | purple_blist_request_add_group (void) |
Requests from the user information needed to add a group to the buddy list. | |
void | purple_blist_node_set_bool (PurpleBlistNode *node, const char *key, gboolean value) |
Associates a boolean with a node in the buddy list. | |
gboolean | purple_blist_node_get_bool (PurpleBlistNode *node, const char *key) |
Retrieves a named boolean setting from a node in the buddy list. | |
void | purple_blist_node_set_int (PurpleBlistNode *node, const char *key, int value) |
Associates an integer with a node in the buddy list. | |
int | purple_blist_node_get_int (PurpleBlistNode *node, const char *key) |
Retrieves a named integer setting from a node in the buddy list. | |
void | purple_blist_node_set_string (PurpleBlistNode *node, const char *key, const char *value) |
Associates a string with a node in the buddy list. | |
const char * | purple_blist_node_get_string (PurpleBlistNode *node, const char *key) |
Retrieves a named string setting from a node in the buddy list. | |
void | purple_blist_node_remove_setting (PurpleBlistNode *node, const char *key) |
Removes a named setting from a blist node. | |
void | purple_blist_node_set_flags (PurpleBlistNode *node, PurpleBlistNodeFlags flags) |
Set the flags for the given node. | |
PurpleBlistNodeFlags | purple_blist_node_get_flags (PurpleBlistNode *node) |
Get the current flags on a given node. | |
PurpleBlistNodeType | purple_blist_node_get_type (PurpleBlistNode *node) |
Get the type of a given node. | |
GList * | purple_blist_node_get_extended_menu (PurpleBlistNode *n) |
Retrieves the extended menu items for a buddy list node. | |
UI Registration Functions <br> | |
void | purple_blist_set_ui_ops (PurpleBlistUiOps *ops) |
Sets the UI operations structure to be used for the buddy list. | |
PurpleBlistUiOps * | purple_blist_get_ui_ops (void) |
Returns the UI operations structure to be used for the buddy list. | |
Buddy List Subsystem <br> | |
void * | purple_blist_get_handle (void) |
Returns the handle for the buddy list subsystem. | |
void | purple_blist_init (void) |
Initializes the buddy list subsystem. | |
void | purple_blist_uninit (void) |
Uninitializes the buddy list subsystem. | |
#define PURPLE_BLIST_NODE | ( | obj | ) | ((PurpleBlistNode *)(obj)) |
#define PURPLE_BLIST_NODE_HAS_FLAG | ( | b, | |
f | |||
) | (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f)) |
#define PURPLE_BLIST_NODE_IS_BUDDY | ( | n | ) | (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE) |
#define PURPLE_BLIST_NODE_IS_CHAT | ( | n | ) | (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE) |
#define PURPLE_BLIST_NODE_IS_CONTACT | ( | n | ) | (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE) |
#define PURPLE_BLIST_NODE_IS_GROUP | ( | n | ) | (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE) |
#define PURPLE_BLIST_NODE_IS_VISIBLE | ( | b | ) | (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_INVISIBLE)) |
#define PURPLE_BLIST_NODE_NAME | ( | n | ) |
#define PURPLE_BLIST_NODE_SHOULD_SAVE | ( | b | ) | (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE)) |
#define PURPLE_BUDDY | ( | obj | ) | ((PurpleBuddy *)(obj)) |
#define PURPLE_BUDDY_IS_ONLINE | ( | b | ) |
#define PURPLE_CHAT | ( | obj | ) | ((PurpleChat *)(obj)) |
#define PURPLE_CONTACT | ( | obj | ) | ((PurpleContact *)(obj)) |
#define PURPLE_GROUP | ( | obj | ) | ((PurpleGroup *)(obj)) |
typedef struct _PurpleBlistNode PurpleBlistNode |
typedef struct _PurpleBlistUiOps PurpleBlistUiOps |
typedef struct _PurpleBuddy PurpleBuddy |
typedef struct _PurpleBuddyList PurpleBuddyList |
typedef struct _PurpleChat PurpleChat |
typedef struct _PurpleContact PurpleContact |
typedef struct _PurpleGroup PurpleGroup |
enum PurpleBlistNodeFlags |
void purple_blist_add_account | ( | PurpleAccount * | account | ) |
Called when an account connects.
Tells the UI to update all the buddies.
account | The account |
void purple_blist_add_buddy | ( | PurpleBuddy * | buddy, |
PurpleContact * | contact, | ||
PurpleGroup * | group, | ||
PurpleBlistNode * | node | ||
) |
Adds a new buddy to the buddy list.
The buddy will be inserted right after node or prepended to the group if node is NULL. If both are NULL, the buddy will be added to the "Buddies" group.
buddy | The new buddy who gets added |
contact | The optional contact to place the buddy in. |
group | The group to add the new buddy to. |
node | The insertion point. Pass in NULL to add the node as the first child in the given group. |
void purple_blist_add_chat | ( | PurpleChat * | chat, |
PurpleGroup * | group, | ||
PurpleBlistNode * | node | ||
) |
Adds a new chat to the buddy list.
The chat will be inserted right after node or appended to the end of group if node is NULL. If both are NULL, the buddy will be added to the "Chats" group.
chat | The new chat who gets added |
group | The group to add the new chat to. |
node | The insertion point |
void purple_blist_add_contact | ( | PurpleContact * | contact, |
PurpleGroup * | group, | ||
PurpleBlistNode * | node | ||
) |
Adds a new contact to the buddy list.
The new contact will be inserted after insert or prepended to the list if node is NULL.
contact | The contact |
group | The group to add the contact to |
node | The insertion point |
void purple_blist_add_group | ( | PurpleGroup * | group, |
PurpleBlistNode * | node | ||
) |
Adds a new group to the buddy list.
The new group will be inserted after insert or prepended to the list if node is NULL.
group | The group |
node | The insertion point |
void purple_blist_alias_buddy | ( | PurpleBuddy * | buddy, |
const char * | alias | ||
) |
Aliases a buddy in the buddy list.
buddy | The buddy whose alias will be changed. |
alias | The buddy's alias. |
void purple_blist_alias_chat | ( | PurpleChat * | chat, |
const char * | alias | ||
) |
Aliases a chat in the buddy list.
chat | The chat whose alias will be changed. |
alias | The chat's new alias. |
void purple_blist_alias_contact | ( | PurpleContact * | contact, |
const char * | alias | ||
) |
Aliases a contact in the buddy list.
contact | The contact whose alias will be changed. |
alias | The contact's alias. |
void purple_blist_destroy | ( | void | ) |
Destroys the buddy list window.
PurpleChat * purple_blist_find_chat | ( | PurpleAccount * | account, |
const char * | name | ||
) |
Finds a chat by name.
account | The chat's account. |
name | The chat's name. |
NULL
if the chat does not exist. GSList * purple_blist_get_buddies | ( | void | ) |
Returns a list of every buddy in the list.
Use of this function is discouraged if you do not actually need every buddy in the list. Use purple_find_buddies instead.
int purple_blist_get_group_online_count | ( | PurpleGroup * | group | ) |
Determines the number of online buddies in a group.
group | The group |
int purple_blist_get_group_size | ( | PurpleGroup * | group, |
gboolean | offline | ||
) |
Determines the total size of a group.
group | The group |
offline | Count buddies in offline accounts |
void * purple_blist_get_handle | ( | void | ) |
Returns the handle for the buddy list subsystem.
PurpleBlistNode * purple_blist_get_root | ( | void | ) |
Returns the root node of the main buddy list.
gpointer purple_blist_get_ui_data | ( | void | ) |
Returns the UI data for the list.
PurpleBlistUiOps * purple_blist_get_ui_ops | ( | void | ) |
Returns the UI operations structure to be used for the buddy list.
void purple_blist_merge_contact | ( | PurpleContact * | source, |
PurpleBlistNode * | node | ||
) |
Merges two contacts.
All of the buddies from source will be moved to target
source | The contact to merge |
node | The place to merge to (a buddy or contact) |
PurpleBuddyList * purple_blist_new | ( | void | ) |
Creates a new buddy list.
gboolean purple_blist_node_get_bool | ( | PurpleBlistNode * | node, |
const char * | key | ||
) |
Retrieves a named boolean setting from a node in the buddy list.
node | The node to retrieve the data from |
key | The identifier of the data |
GList * purple_blist_node_get_extended_menu | ( | PurpleBlistNode * | n | ) |
Retrieves the extended menu items for a buddy list node.
n | The blist node for which to obtain the extended menu items. |
PurpleBlistNode * purple_blist_node_get_first_child | ( | PurpleBlistNode * | node | ) |
Returns the the first child node of a given node.
node | A node. |
PurpleBlistNodeFlags purple_blist_node_get_flags | ( | PurpleBlistNode * | node | ) |
Get the current flags on a given node.
node | The node from which to get the flags. |
int purple_blist_node_get_int | ( | PurpleBlistNode * | node, |
const char * | key | ||
) |
Retrieves a named integer setting from a node in the buddy list.
node | The node to retrieve the data from |
key | The identifier of the data |
PurpleBlistNode * purple_blist_node_get_parent | ( | PurpleBlistNode * | node | ) |
Returns the parent node of a given node.
node | A node. |
PurpleBlistNode * purple_blist_node_get_sibling_next | ( | PurpleBlistNode * | node | ) |
Returns the sibling node of a given node.
node | A node. |
PurpleBlistNode * purple_blist_node_get_sibling_prev | ( | PurpleBlistNode * | node | ) |
Returns the previous sibling node of a given node.
node | A node. |
const char * purple_blist_node_get_string | ( | PurpleBlistNode * | node, |
const char * | key | ||
) |
Retrieves a named string setting from a node in the buddy list.
node | The node to retrieve the data from |
key | The identifier of the data |
PurpleBlistNodeType purple_blist_node_get_type | ( | PurpleBlistNode * | node | ) |
Get the type of a given node.
node | The node. |
gpointer purple_blist_node_get_ui_data | ( | const PurpleBlistNode * | node | ) |
Returns the UI data of a given node.
node | The node. |
PurpleBlistNode * purple_blist_node_next | ( | PurpleBlistNode * | node, |
gboolean | offline | ||
) |
Returns the next node of a given node.
This function is to be used to iterate over the tree returned by purple_get_blist.
node | A node. |
offline | Whether to include nodes for offline accounts |
void purple_blist_node_remove_setting | ( | PurpleBlistNode * | node, |
const char * | key | ||
) |
Removes a named setting from a blist node.
node | The node from which to remove the setting |
key | The name of the setting |
void purple_blist_node_set_bool | ( | PurpleBlistNode * | node, |
const char * | key, | ||
gboolean | value | ||
) |
Associates a boolean with a node in the buddy list.
node | The node to associate the data with |
key | The identifier for the data |
value | The value to set |
void purple_blist_node_set_flags | ( | PurpleBlistNode * | node, |
PurpleBlistNodeFlags | flags | ||
) |
Set the flags for the given node.
Setting a node's flags will overwrite the old flags, so if you want to save them, you must first call purple_blist_node_get_flags and modify that appropriately.
node | The node on which to set the flags. |
flags | The flags to set. This is a bitmask. |
void purple_blist_node_set_int | ( | PurpleBlistNode * | node, |
const char * | key, | ||
int | value | ||
) |
Associates an integer with a node in the buddy list.
node | The node to associate the data with |
key | The identifier for the data |
value | The value to set |
void purple_blist_node_set_string | ( | PurpleBlistNode * | node, |
const char * | key, | ||
const char * | value | ||
) |
Associates a string with a node in the buddy list.
node | The node to associate the data with |
key | The identifier for the data |
value | The value to set |
void purple_blist_node_set_ui_data | ( | PurpleBlistNode * | node, |
gpointer | ui_data | ||
) |
Sets the UI data of a given node.
node | The node. |
ui_data | The UI data. |
void purple_blist_remove_account | ( | PurpleAccount * | account | ) |
Called when an account disconnects.
Sets the presence of all the buddies to 0 and tells the UI to update them.
account | The account |
void purple_blist_remove_buddy | ( | PurpleBuddy * | buddy | ) |
Removes a buddy from the buddy list and frees the memory allocated to it.
This doesn't actually try to remove the buddy from the server list.
buddy | The buddy to be removed |
void purple_blist_remove_chat | ( | PurpleChat * | chat | ) |
Removes a chat from the buddy list and frees the memory allocated to it.
chat | The chat to be removed |
void purple_blist_remove_contact | ( | PurpleContact * | contact | ) |
Removes a contact, and any buddies it contains, and frees the memory allocated to it.
This calls purple_blist_remove_buddy and therefore doesn't remove the buddies from the server list.
contact | The contact to be removed |
void purple_blist_remove_group | ( | PurpleGroup * | group | ) |
Removes a group from the buddy list and frees the memory allocated to it and to its children.
group | The group to be removed |
void purple_blist_rename_buddy | ( | PurpleBuddy * | buddy, |
const char * | name | ||
) |
Renames a buddy in the buddy list.
buddy | The buddy whose name will be changed. |
name | The new name of the buddy. |
void purple_blist_rename_group | ( | PurpleGroup * | group, |
const char * | name | ||
) |
Renames a group.
group | The group to rename |
name | The new name |
void purple_blist_request_add_buddy | ( | PurpleAccount * | account, |
const char * | username, | ||
const char * | group, | ||
const char * | alias | ||
) |
Requests from the user information needed to add a buddy to the buddy list.
account | The account the buddy is added to. |
username | The username of the buddy. |
group | The name of the group to place the buddy in. |
alias | The optional alias for the buddy. |
void purple_blist_request_add_chat | ( | PurpleAccount * | account, |
PurpleGroup * | group, | ||
const char * | alias, | ||
const char * | name | ||
) |
Requests from the user information needed to add a chat to the buddy list.
account | The account the buddy is added to. |
group | The optional group to add the chat to. |
alias | The optional alias for the chat. |
name | The required chat name. |
void purple_blist_schedule_save | ( | void | ) |
Schedule a save of the blist.xml file.
This is used by the privacy API whenever the privacy settings are changed. If you make a change to blist.xml using one of the functions in the buddy list API, then the buddy list is saved automatically, so you should not need to call this.
void purple_blist_server_alias_buddy | ( | PurpleBuddy * | buddy, |
const char * | alias | ||
) |
Sets the server-sent alias of a buddy in the buddy list.
PRPLs should call serv_got_alias() instead of this.
buddy | The buddy whose alias will be changed. |
alias | The buddy's "official" alias. |
void purple_blist_set_ui_data | ( | gpointer | ui_data | ) |
Sets the UI data for the list.
ui_data | The UI data for the list. |
void purple_blist_set_ui_ops | ( | PurpleBlistUiOps * | ops | ) |
Sets the UI operations structure to be used for the buddy list.
ops | The ops struct. |
void purple_blist_set_visible | ( | gboolean | show | ) |
Hides or unhides the buddy list.
show | Whether or not to show the buddy list |
void purple_blist_update_buddy_icon | ( | PurpleBuddy * | buddy | ) |
Updates a buddy's icon.
buddy | The buddy whose buddy icon has changed |
void purple_blist_update_buddy_status | ( | PurpleBuddy * | buddy, |
PurpleStatus * | old_status | ||
) |
Updates a buddy's status.
This should only be called from within Purple.
buddy | The buddy whose status has changed. |
old_status | The status from which we are changing. |
void purple_blist_update_node_icon | ( | PurpleBlistNode * | node | ) |
Updates a node's custom icon.
node | The PurpleBlistNode whose custom icon has changed. |
void purple_buddy_destroy | ( | PurpleBuddy * | buddy | ) |
Destroys a buddy.
buddy | The buddy to destroy |
PurpleAccount * purple_buddy_get_account | ( | const PurpleBuddy * | buddy | ) |
Returns a buddy's account.
buddy | The buddy. |
const char * purple_buddy_get_alias | ( | PurpleBuddy * | buddy | ) |
Returns the correct name to display for a buddy.
In order of precedence: the buddy's alias; the buddy's server alias; the buddy's contact alias; the buddy's user name.
buddy | The buddy whose name will be returned. |
const char * purple_buddy_get_alias_only | ( | PurpleBuddy * | buddy | ) |
Returns the alias of a buddy.
buddy | The buddy whose name will be returned. |
PurpleContact * purple_buddy_get_contact | ( | PurpleBuddy * | buddy | ) |
Returns a buddy's contact.
buddy | The buddy. |
const char * purple_buddy_get_contact_alias | ( | PurpleBuddy * | buddy | ) |
Returns the correct name to display for a buddy, taking the contact alias into account.
In order of precedence: the buddy's alias; the buddy's contact alias; the buddy's server alias; the buddy's user name.
buddy | The buddy whose name will be returned |
PurpleGroup * purple_buddy_get_group | ( | PurpleBuddy * | buddy | ) |
Returns the group of which the buddy is a member.
buddy | The buddy |
PurpleBuddyIcon * purple_buddy_get_icon | ( | const PurpleBuddy * | buddy | ) |
Returns a buddy's icon.
buddy | The buddy. |
const char * purple_buddy_get_local_alias | ( | PurpleBuddy * | buddy | ) |
Returns the correct alias for this user, ignoring server aliases.
Used when a user-recognizable name is required. In order: buddy's alias; buddy's contact alias; buddy's user name.
buddy | The buddy whose alias will be returned. |
const char * purple_buddy_get_local_buddy_alias | ( | PurpleBuddy * | buddy | ) |
Returns the local alias for the buddy, or NULL
if none exists.
buddy | The buddy |
PurpleMediaCaps purple_buddy_get_media_caps | ( | const PurpleBuddy * | buddy | ) |
Gets the media caps from a buddy.
buddy | The buddy. |
const char * purple_buddy_get_name | ( | const PurpleBuddy * | buddy | ) |
Returns a buddy's name.
buddy | The buddy. |
PurplePresence * purple_buddy_get_presence | ( | const PurpleBuddy * | buddy | ) |
Returns a buddy's presence.
buddy | The buddy. |
gpointer purple_buddy_get_protocol_data | ( | const PurpleBuddy * | buddy | ) |
Returns a buddy's protocol-specific data.
This should only be called from the associated prpl.
buddy | The buddy. |
const char * purple_buddy_get_server_alias | ( | PurpleBuddy * | buddy | ) |
Gets the server alias for a buddy.
buddy | The buddy whose name will be returned |
PurpleBuddy * purple_buddy_new | ( | PurpleAccount * | account, |
const char * | name, | ||
const char * | alias | ||
) |
Creates a new buddy.
This function only creates the PurpleBuddy. Use purple_blist_add_buddy to add the buddy to the list and purple_account_add_buddy to sync up with the server.
account | The account this buddy will get added to |
name | The name of the new buddy |
alias | The alias of the new buddy (or NULL if unaliased) |
void purple_buddy_set_icon | ( | PurpleBuddy * | buddy, |
PurpleBuddyIcon * | icon | ||
) |
Sets a buddy's icon.
This should only be called from within Purple. You probably want to call purple_buddy_icon_set_data().
buddy | The buddy. |
icon | The buddy icon. |
void purple_buddy_set_media_caps | ( | PurpleBuddy * | buddy, |
PurpleMediaCaps | media_caps | ||
) |
Sets the media caps for a buddy.
buddy | The PurpleBuddy. |
media_caps | The PurpleMediaCaps. |
void purple_buddy_set_protocol_data | ( | PurpleBuddy * | buddy, |
gpointer | data | ||
) |
Sets a buddy's protocol-specific data.
This should only be called from the associated prpl.
buddy | The buddy. |
data | The data. |
void purple_chat_destroy | ( | PurpleChat * | chat | ) |
Destroys a chat.
chat | The chat to destroy |
PurpleAccount * purple_chat_get_account | ( | PurpleChat * | chat | ) |
Returns the account the chat belongs to.
chat | The chat. |
GHashTable * purple_chat_get_components | ( | PurpleChat * | chat | ) |
Get a hashtable containing information about a chat.
chat | The chat. |
PurpleGroup * purple_chat_get_group | ( | PurpleChat * | chat | ) |
Returns the group of which the chat is a member.
chat | The chat. |
NULL
if the chat is not in a group. const char * purple_chat_get_name | ( | PurpleChat * | chat | ) |
Returns the correct name to display for a blist chat.
chat | The chat whose name will be returned. |
PurpleChat * purple_chat_new | ( | PurpleAccount * | account, |
const char * | alias, | ||
GHashTable * | components | ||
) |
Creates a new chat for the buddy list.
account | The account this chat will get added to |
alias | The alias of the new chat |
components | The info the prpl needs to join the chat. The hash function should be g_str_hash() and the equal function should be g_str_equal(). |
void purple_contact_destroy | ( | PurpleContact * | contact | ) |
Destroys a contact.
contact | The contact to destroy |
const char * purple_contact_get_alias | ( | PurpleContact * | contact | ) |
Gets the alias for a contact.
contact | The contact |
PurpleGroup * purple_contact_get_group | ( | const PurpleContact * | contact | ) |
Gets the PurpleGroup from a PurpleContact.
contact | The contact |
PurpleBuddy * purple_contact_get_priority_buddy | ( | PurpleContact * | contact | ) |
Returns the highest priority buddy for a given contact.
contact | The contact |
void purple_contact_invalidate_priority_buddy | ( | PurpleContact * | contact | ) |
Invalidates the priority buddy so that the next call to purple_contact_get_priority_buddy recomputes it.
contact | The contact |
PurpleContact * purple_contact_new | ( | void | ) |
Creates a new contact.
gboolean purple_contact_on_account | ( | PurpleContact * | contact, |
PurpleAccount * | account | ||
) |
Determines whether an account owns any buddies in a given contact.
contact | The contact to search through. |
account | The account. |
void purple_contact_set_alias | ( | PurpleContact * | contact, |
const char * | alias | ||
) |
Sets the alias for a contact.
contact | The contact |
alias | The alias to set, or NULL to unset |
GSList * purple_find_buddies | ( | PurpleAccount * | account, |
const char * | name | ||
) |
Finds all PurpleBuddy structs given a name and an account.
account | The account this buddy belongs to |
name | The buddy's name (or NULL to return all buddies for the account) |
PurpleBuddy * purple_find_buddy | ( | PurpleAccount * | account, |
const char * | name | ||
) |
Finds the buddy struct given a name and an account.
account | The account this buddy belongs to |
name | The buddy's name |
PurpleBuddy * purple_find_buddy_in_group | ( | PurpleAccount * | account, |
const char * | name, | ||
PurpleGroup * | group | ||
) |
Finds the buddy struct given a name, an account, and a group.
account | The account this buddy belongs to |
name | The buddy's name |
group | The group to look in |
PurpleGroup * purple_find_group | ( | const char * | name | ) |
Finds a group by name.
name | The group's name |
PurpleBuddyList * purple_get_blist | ( | void | ) |
Returns the main buddy list.
void purple_group_destroy | ( | PurpleGroup * | group | ) |
Destroys a group.
group | The group to destroy |
GSList * purple_group_get_accounts | ( | PurpleGroup * | g | ) |
Returns a list of accounts that have buddies in this group.
g | The group |
const char * purple_group_get_name | ( | PurpleGroup * | group | ) |
Returns the name of a group.
group | The group. |
PurpleGroup * purple_group_new | ( | const char * | name | ) |
Creates a new group.
You can't have more than one group with the same name. Sorry. If you pass this the name of a group that already exists, it will return that group.
name | The name of the new group |
gboolean purple_group_on_account | ( | PurpleGroup * | g, |
PurpleAccount * | account | ||
) |
Determines whether an account owns any buddies in a given group.
g | The group to search through. |
account | The account. |
void purple_set_blist | ( | PurpleBuddyList * | blist | ) |
Sets the main buddy list.
blist | The buddy list you want to use. |