A PurpleAccount is the core configuration for connecting to a specific account. User interfaces typically allow users to create these in a dialog or wizard.

A manager that keeps track of all PurpleAccounts.

since: 3.0.0

A PurpleAccountPresence represent the PurplePresence for a specific PurpleAccount.

PurpleAddContactRequest is a data structure that contains all of the information when someone has added you to their contact list, so the user interface can ask the user to add the remote user to their contact list.

since: 3.0.0

PurpleAttachment represents a file attached to a PurpleMessage.

PurpleAuthorizationRequest is a data structure that contains all of the information when someone has requested authorization to add you to their contact list.

since: 3.0.0

A representation of an Avatar that is used for accounts, contacts, and conversations.

since: 3.0.0

A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for PurpleBuddy, PurpleContact, PurpleGroup, and for anything else that wants to put itself in the buddy list.

A buddy on the buddy list.

The Buddy List.

A PurpleBuddyPresence represent the PurplePresence for a specific PurpleBuddy.

The details that are necessary for a PurpleProtocol to join a channel. A user interface will ask a protocol for a PurpleChannelJoinDetails and then fill it out and pass it back to the protocol to actually join a channel.

since: 3.0.0

A chat on the buddy list.

Structure representing a chat conversation instance.

Structure representing a chat user instance.

Represents an active connection on an account.

A contact is a concrete representation of a user in that it contains all of the contact information as well as a PurpleAccount to use that contact information with.

The information about a contact. This information is used everywhere you need to refer to a user. Be it a chat, an direct message, a file transfer, etc.

A manager for PurpleContacts.

since: 3.0.0

A core representation of a conversation between two or more people.

PurpleConversationManager keeps track of all PurpleConversation‘s inside of libpurple and allows searching of them.

since: 3.0.0

A conversation member links a PurpleContactInfo to a PurpleConversation as well as any data that is unique to the link.

since: 3.0.0

A node that keeps count of the number of children that it has. It tracks the total number of children, the number of children corresponding to online accounts, and the number of online children.

since: 3.0.0

Purple Credential Manager is the main API access to different credential providers. Providers register themselves with the manager and then the user can choose which provider to use.

since: 3.0.0

PurpleCredentialProvider is an abstract base class for implementing support for a specific password or keyring manager. At the time of this writing, libpurple ships with plugins for libsecret, macOS Keychain Access, KWallet, and the Windows Credentials store by subclassing PurpleCredentialProvider.

since: 3.0.0

PurpleHistoryAdapter is a base class that should be sub classed by history adapters. It defines the behavior of all history adapters and implements some shared properties.

since: 3.0.0

PurpleHistoryManager keeps track of all adapters and emits signals when adapters are registered and unregistered.

since: 3.0.0

PurpleImage object is a container for raw image data. It doesn’t manipulate image data, just stores it in its binary format - png, jpeg etc. Thus, it’s totally independent from the UI.

Structure representing an IM conversation instance.

The media instance.

An opaque structure representing a network candidate (IP Address and port pair).

An opaque structure representing an audio or video codec.

An opaque structure representing an audio/video source/sink.

The media manager’s data.

PurpleMessage represents any message passed between users in libpurple.

A contact on the buddy list.

PurpleNoopCredentialProvider is a PurpleCredentialProvider that does not actually provider credentials. It is used to implement the default behavior of requiring users to input passwords.

since: 3.0.0

An object that represents a notification.

since: 3.0.0

Purple Notification Manager manages all notifications between protocols and plugins and how the user interface interacts with them.

since: 3.0.0

A collection of PurpleContactInfo that contains a user selectable custom avatar and alias.

since: 3.0.0

PurplePluginInfo is a GPluginPluginInfo subclass that adds additional libpurple specific properties.

since: 3.0.0

A PurplePresence is like a collection of PurpleStatuses (plus some other random info). For any buddy, or for any one of your accounts, or for any person with which you’re chatting, you may know various amounts of information. This information is all contained in one PurplePresence. If one of your buddies is away and idle, then the presence contains the PurpleStatus for their awayness, and it contains their current idle time. PurplePresence‘s are never saved to disk. The information they contain is only relevant for the current Purple session.

PurpleProtocol is the base type for all protocols in libpurple.

since: 3.0.0

PurpleProtocolManager keeps track of all protocols and emits signals when protocols are registered and unregistered.

since: 3.0.0

An implementation of GFilterOutputStream which allows queuing data for output. This allows data to be queued while other data is being output. Therefore, data doesn’t have to be manually stored while waiting for stream operations to finish.

since: 3.0.0

A request field.

since: 3.0.0

An account request field.

since: 3.0.0

A boolean request field.

since: 3.0.0

A choice request field.

since: 3.0.0

A datasheet request field.

since: 3.0.0

An image request field.

since: 3.0.0

An integer request field.

since: 3.0.0

A label request field.

since: 3.0.0

A list request field.

since: 3.0.0

A string request field.

since: 3.0.0

A group of fields with a title.

since: 3.0.0

Multiple fields request data.

since: 3.0.0

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

PurpleRoomlistRoom keeps track of all PurpleConversation‘s inside of libpurple and allows searching of them.

since: 3.0.0

PurpleSqliteHistoryAdapter is a class that allows interfacing with an SQLite database to store history. It is a subclass of PurpleHistoryAdapter.

since: 3.0.0

A PurpleStatus can be thought of as an “instance” of a PurpleStatusType. If you’re familiar with object-oriented programming languages then this should be immediately clear. Say, for example, that one of your AIM buddies has set himself as “away.” You have a PurpleBuddy node for this person in your buddy list. Purple wants to mark this buddy as “away,” so it creates a new PurpleStatus. The PurpleStatus has its PurpleStatusType set to the “away” state for the oscar protocol. The PurpleStatus also contains the buddy’s away message. PurpleStatuses are sometimes saved, depending on the context. The current PurpleStatuses associated with each of your accounts are saved so that the next time you start Purple, your accounts will be set to their last known statuses. There is also a list of saved statuses that are written to the status.xml file. Also, each PurpleStatus has a “saveable” boolean. If “saveable” is set to FALSE then the status is NEVER saved. All PurpleStatuses should be inside a PurplePresence.

Tags is an object that can be used to keep track of arbitrary tags on objects. Tags are simple strings that use the first ‘:’ to delimit a value. For example: foo is a tag with just a name and no value, but foo:bar is a tag with a name and value. Please note this distinction when the API calls for a name versus a tag which would be the name and the value.

since: 3.0.0

An abstract class representing a user interface. All user interfaces must create a subclass of this and pass it to purple_core_init().

since: 3.0.0

A abstract whiteboard object.

PurpleWhiteboardManager keeps track of all whiteboards and emits signals when whiteboards are registered and unregistered.

since: 3.0.0

PurpleDebugUiInterface defines the behavior that libpurple uses to interface the debug API with the user interface.

since: 3.0.0

A placeholder to represent any media backend.

The PurpleProtocolActions interface defines the behavior of a protocol’s actions interface.

since: 3.0.0

PurpleProtocolChat describes the API that protocols need to implement for handling multiple user conversations.

since: 3.0.0

PurpleProtocolClient interface defines the behavior of a typical chat service’s client interface.

PurpleProtocolContacts provides methods for interacting with remote contacts.

since: 3.0.0

The PurpleProtocolContactSearch interface defines the behavior to search for new contacts to add to your contact list. A user interface will use these methods to help users find new contacts.

since: 3.0.0

PurpleProtocolIM describes the API that protocols need to implement for handling one on one conversations.

since: 3.0.0

PurpleProtocolMedia describes the multimedia api that is available for protocols.

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

The PurpleProtocolRoster interface defines the behavior to tell a protocol when the users wants to manage contacts on the server side roster.

since: 3.0.0

PurpleProtocolServer describes the API for protocols that have a central server.

since: 3.0.0

The PurpleProtocolWhiteboard interface defines the behavior of a protocol’s whiteboard interface.

since: 3.0.0

An option for an account.

A username split.

A generic structure that contains information about an “action”. One place this is used is by protocols to tell the core the list of available right-click actions for a buddy list row.

An opaque structure representing a buddy icon for a particular user on a particular PurpleAccount. Instances are reference-counted; use purple_buddy_icon_ref() and purple_buddy_icon_unref() to take and release references.

A description of a Buddy Icon specification. This tells Purple what kind of image file it should give a protocol, and what kind of image file it should expect back. Dimensions less than 1 should be ignored and the image not scaled.

Holds the type of an error along with its description.

Connection UI operations. Used to notify the user of changes to connections, such as being disconnected, and to respond to the underlying network connection appearing and disappearing. UIs should call #purple_connections_set_ui_ops() with an instance of this struct.

Libpurple needs to tell the user interface when certain things happen in a conversation and it uses this structure to do so.

A key-value pair.

A set of callbacks that can be installed on an Application data session with purple_media_manager_set_application_data_callbacks()

Definition of a button.

Single column of a search result.

Search results object.

Notification UI operations.

Opaque type to carry callback information.

since: 2.11.0

Represents an action that the protocol can perform. This shows up in the Accounts menu, under a submenu with the name of the account.

Represents an entry containing information that must be supplied by the user when joining a chat.

Common parameters for UI operations.

Request Datasheet is a UI abstracted table.

Request UI operations.

The room list ops to be filled out by the UI.

Saved statuses don’t really interact much with the rest of Purple. It could really be a plugin. It’s just a list of away states. When a user chooses one of the saved states, their Purple accounts are set to the settings of that state.

PurpleStatusType’s are created by each protocol. They outline the available statuses of the protocol. AIM, for example, supports an available state with an optional available message, an away state with a mandatory message, and an invisible state (which is technically “independent” of the other two, but we’ll get into that later). PurpleStatusTypes are very permanent. They are hardcoded in each protocol and will not change often. And because they are hardcoded, they do not need to be saved to any XML file.

Whiteboard protocol operations.

The PurpleWhiteboard UI Operations.

File transfer UI operations.

XmlNode is a simplified API for handling XML. An XmlNode represents an XML element and has API for children as well as attributes.

A unique integer representing a command registered with purple_cmd_register(), which can subsequently be passed to purple_cmd_unregister() to unregister that command.

Represents a plugin handle. This type is an alias for GPluginPlugin.

A sqlite3 connection.

Account request response types.

Flags used to set various properties of commands. Every command should have at least one of #PURPLE_CMD_FLAG_IM and #PURPLE_CMD_FLAG_CHAT set in order to be even slightly useful.

Commands are registered from multiple locations which leads to name collisions. PurpleCmdPriority is used to determine which command will be run.

Commands registered with the core return one of these values when run. Normally, a command will want to return one of the first two; in some unusual cases, you might want to have several functions called for a particular command; in this case, they should return

PURPLE_CMD_RET_CONTINUE to cause the core to fall through to other

commands with the same name.

The possible results of running a command with purple_cmd_do_command().

Possible errors that can cause a connection to be closed.

A representation of the state of a PurpleConnection.

A representation of whether or not a contact has permission to contact the user.

since: 3.0.0

The type of the conversation. This is mostly ignored, but could be useful in ways we can’t imagine right now. If you come up with one in the future, please let us know!

since: 3.0.0

Conversation update type.

Available debug levels.

The typing state of a user.

Media candidate types.

Media caps.

Media component types.

Media info types.

Media network protocols.

Media state-changed types.

The message formatting for the message.

since: 3.0.0

since: 3.0.0.

Notification message types.

Constant values to define the type of buttons to use in a request dialog. These are used by user interfaces to label and possibly add an icon to the button.

Notification types.

Types of PurpleNotifyUserInfoEntry objects.

Preference data types.

An enum that is used to determine the type of a PurplePresence.

since: 3.0.0

A type of proxy connection.

The type of data to be shown in a column.

Feature flags for the request api.

Constants to define which kind of icon should be displayed.

Request types.

The types of fields.

A primitive defining the basic structure of a status type.

Defines the state of a user composing a message.

since: 3.0.0

The different states of the xfer.

Types of file transfers.

The valid types for an PurpleXmlNode.

Flags applicable to users in Chats.

Flags to change behavior of the client for a given connection.

An input condition.

Media session types.

Flags applicable to a message. Most will have send, recv or system.

Flags that can be used to treat plugins differently.

since: 3.0.0

Protocol options.

A function used as a callback with purple_account_manager_foreach().

since: 3.0.0

Called when iterating PurpleAttachment‘s.

since: 3.0.0

A callback function for purple_blist_walk.

since: 3.0.0

A function implementing a command, as passed to purple_cmd_register().

A function to be used as a callback with purple_conversation_manager_foreach().

since: 3.0.0

A function to be used as a callback with purple_credential_manager_foreach().

since: 3.0.0

A function to be used as a callback with purple_history_manager_foreach().

since: 3.0.0

The type of callbacks to handle events on file descriptors, as passed to purple_input_add(). The callback will receive the user_data passed to purple_input_add(), the file descriptor on which the event occurred, and the condition that was satisfied to cause the callback to be invoked.

Used as a parameter to purple_menu_walk(). While walking, model will be updated to point to the current section or submenu and will only be the model that was passed to purple_menu_walk() for its immediate children.

since: 3.0.0

Notification close callbacks.

Callback for a button in a search result.

The type of callbacks for preference changes.

A function to be used as a callback with purple_protocol_manager_foreach().

since: 3.0.0

The type of callbacks passed to purple_request_action(). The first argument is the user_data parameter; the second is the index in the list of actions of the one chosen.

A callback that’s used to handle cancel actions.

The type of callbacks passed to purple_request_choice(). The first argument is the user_data parameter; the second is the values of those choice.

A function that is called to determine if the account should be matched.

since: 3.0.0

A callback to check whether a field is valid.

A generic function pointer type used to register signals.

Deletes an account.

Returns the accounts subsystem handle.

Initializes the accounts subsystem.

This is called by the core after all subsystems and what not have been initialized. It sets all enabled accounts to their startup status by signing them on, setting them away, etc.

Schedules saving of accounts.

Uninitializes the accounts subsystem.

Returns a hash table of attributes constructed from args.

since: 3.0.0

Called when an account connects. Tells the UI to update all the buddies.

Adds a new buddy to the buddy list.

Adds a new chat to the buddy list.

Adds a new contact to the buddy list.

Adds a new group to the buddy list.

Loads the buddy list.

Finds all PurpleBuddy structs given a name and an account.

Finds the buddy struct given a name and an account.

Finds the buddy struct given a name, an account, and a group.

Finds a chat by name.

Finds a group by name.

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_blist_find_buddies instead.

Returns the default buddy list.

since: 3.0.0

Finds or creates default group.

Gets the default group name for the buddy list.

since: 3.0.0

Returns the root node of the default buddy list.

since: 3.0.0

Returns the handle for the buddy list subsystem.

Returns the root node of the specified buddy list.

Initializes the buddy list subsystem.

Sets UI-specific data on a node.

since: 3.0.0

Called when an account disconnects. Sets the presence of all the buddies to 0 and tells the UI to update them.

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.

Removes a chat from the buddy list and frees the memory allocated to it.

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.

Removes a group from the buddy list and frees the memory allocated to it and to its children.

Requests from the user information needed to add a buddy to the buddy list.

Requests from the user information needed to add a chat to the buddy list.

Requests from the user information needed to add a group to the buddy list.

Save all the data for an account.

since: 3.0.0

This is called when a node has been modified and should be saved by the UI.

since: 3.0.0

Schedule a save of the blist.xml file. This is used by the account 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.

Set the UI implementation of the buddy list.

since: 3.0.0

Hides or unhides the buddy list.

Shows the buddy list, creating a new one if necessary.

Uninitializes the buddy list subsystem.

Updates the buddies hash table when a buddy has been renamed. This only updates the cache, the caller is responsible for the actual renaming of the buddy after updating the cache.

Updates the groups hash table when a group has been renamed. This only updates the cache, the caller is responsible for the actual renaming of the group after updating the cache.

Update a node in the buddy list in the UI.

since: 3.0.0

Walks the buddy list and calls the appropriate function for each node. If a callback function is omitted iteration will continue without it.

since: 3.0.0

Returns the purple cache directory according to XDG Base Directory Specification. This is usually $HOME/.cache/purple. If custom user dir was specified then this is cache sub-directory of DIR argument passed to -c option.

Do a command.

Execute a specific command.

Get the help string for a command.

List registered commands.

Register a new command with the core.

Unregister a command with the core.

Get the handle for the commands API.

Initialize the commands subsystem.

Uninitialize the commands subsystem.

Returns the purple configuration directory according to XDG Base Directory Specification. This is usually $HOME/.config/purple. If custom user dir was specified then this is config sub-directory of DIR argument passed to -c option.

Disconnects from all connections.

Returns a list of all active connections. This does not include connections that are in the process of connecting.

Returns the handle to the connections subsystem.

Returns the UI operations structure used for connections.

Initializes the connections subsystem.

Checks if at least one account is online.

Sets the UI operations structure to be used for connections.

Uninitializes the connections subsystem.

Returns the conversation subsystem handle.

Gets the default conversation UI operations structure.

Initializes the conversation subsystem.

Sets the default conversation UI operations structure.

Uninitializes the conversation subsystem.

Returns the purple data directory according to XDG Base Directory Specification. This is usually $HOME/.local/share/purple. If custom user dir was specified then this is data sub-directory of DIR argument passed to -c option.

Outputs debug information.

Outputs error level debug information.

Outputs fatal error level debug information.

Outputs info level debug information.

Initializes the debug subsystem.

Check if unsafe debugging is enabled. Defaults to FALSE.

Check if verbose logging is enabled.

Outputs misc. level debug information.

Enable or disable unsafe debugging. This ordinarily should only be called by purple_debug_init(), but there are cases where this can be useful for plugins.

Enable or disable verbose debugging. This ordinarily should only be called by purple_debug_init(), but there are cases where this can be useful for plugins.

Outputs warning level debug information.

Checks if the given email address is syntactically valid.

Escapes filesystem-unfriendly characters from a filename.

Create a GdkPixbuf from a chunk of image data.

Create a GdkPixbuf from a PurpleImage.

Returns TRUE if the GdkPixbuf is opaque, as determined by no alpha at any of the edge pixels.

Rounds the corners of a GdkPixbuf in place.

Helper function that calls gdk_pixbuf_new_from_file() and checks both the return code and the GError and returns NULL if either one failed.

Helper function that calls gdk_pixbuf_new_from_file_at_size() and checks both the return code and the GError and returns NULL if either one failed.

This is used to connect to core signals.

Returns a GOptionGroup for the commandline arguments recognized by LibPurple. You should add this option group to your GOptionContext with g_option_context_add_group(), if you are using g_option_context_parse() to parse your commandline arguments.

Closes input, output, stream. If there are pending operations, it asynchronously waits for the operations to finish before closing the arguments. Ensure the Gio callbacks can safely handle this being done asynchronously.

A helper function to simplify creating a GSocketClient. It’s intended to be used in protocol plugins.

Returns purple’s global proxy information.

Set purple’s global proxy information.

Gets the user’s home directory.

Gets the current idle reporter.

since: 3.0.0

Initializes the idle system.

Fake our idle time by setting the time at which our accounts purportedly became idle. This is used by the I’dle Mak’er plugin.

Sets the user interface idle reporter.

since: 3.0.0

Touch our idle tracker. This signifies that the user is ‘active’. The conversation code calls this when the user sends an IM, for example.

Uninitializes the idle system.

Adds an input handler.

Creates a pipe - an unidirectional data channel that can be used for interprocess communication.

Returns a newly allocated string containing the name of the tag located at “tag”. Tag is expected to point to a ‘<’, and contain a ‘>’ sometime after that. If there is no ‘>’ and the string is not NUL terminated, this function can be expected to segfault.

Converts HTML markup to XHTML.

Adds the necessary HTML code to turn URIs into HTML links in a string.

Returns a newly allocated substring of the HTML UTF-8 string “str”. The markup is preserved such that the substring will have the same formatting as original string, even though some tags may have been opened before “x”, or may close after “y”. All open tags are closed at the end of the returned string, in the proper order.

Strips HTML tags from a string.

Returns a constant string of the character representation of the HTML entity pointed to by text. For example, purple_markup_unescape_entity(“&amp;”) will return “&”. The text variable is expected to point to an ‘&’, the first character of the entity. If given an unrecognized entity, the function returns NULL.

A purple marshaller function for use with signals with a single pointer argument and returns a boolean.

A purple marshaller function for use with signals with a pointer and boolean argument and returns a boolean.

A purple marshaller function for use with signals with two pointer arguments and returns a boolean.

A purple marshaller function for use with signals with three pointer arguments and returns a boolean.

A purple marshaller function for use with signals with four pointer arguments and returns a boolean.

A purple marshaller function for use with signals with five pointer arguments and returns a boolean.

A purple marshaller function for use with signals with six pointer arguments and returns a boolean.

A purple marshaller function for use with signals with two pointer and one unsigned integer arguments and returns a boolean.

A purple marshaller function for use with signals with three pointer arguments and returns an integer.

A purple marshaller function for use with signals with five pointer arguments and returns an integer.

A purple marshaller function for use with signals with no arguments.

A purple marshaller function for use with signals with a single pointer argument.

A purple marshaller function for use with signals with a pointer and two integer arguments.

A purple marshaller function for use with signals with a pointer, an integer, and then another pointer argument.

A purple marshaller function for use with signals with two pointer arguments.

A purple marshaller function for use with signals with three pointer arguments.

A purple marshaller function for use with signals with four pointer arguments.

A purple marshaller function for use with signals with five pointer arguments.

A purple marshaller function for use with signals with four pointer and one unsigned integer arguments.

A purple marshaller function for use with signals with three pointer and one unsigned integer arguments.

A purple marshaller function for use with signals with three pointer and two unsigned integer arguments.

A purple marshaller function for use with signals with two pointers and an unsigned integer argument.

A purple marshaller function for use with signals with two pointers and two unsigned integer arguments.

A purple marshaller function for use with signals with a pointer and an unsigned integer argument.

A purple marshaller function for use with signals with a pointer and two unsigned integer arguments.

Creates a full copy of model as a new GMenu. If model was not a GMenu instance, any additional functionality will be lost.

since: 3.0.0

Updates menu by adding a target property when an item with an attribute named “dynamic-target” is found.

since: 3.0.0

Updates menu by adding a target property when an item with an attribute named “dynamic-target” is found.

since: 3.0.0

Recursively calls func for each item in model and all of its children.

since: 3.0.0

Discovers the IP address that should be used anywhere a public IP addresses is needed (listening for an incoming file transfer, etc).

since: 3.0.0

Makes purple_network_is_available() always return TRUE.

Returns the IP address that should be used anywhere a public IP address is needed (listening for an incoming file transfer, etc).

Returns the IP address of the local system set in preferences.

Get the IP address of the STUN server as a string representation.

Initializes the network subsystem.

Detects if there is an available network connection.

Sets the IP address of the local system in preferences. This is the IP address that should be used for incoming connections (file transfer, direct IM, etc.) and should therefore be publicly accessible.

Update the STUN server IP given the host name Will result in a DNS query being executed asynchronous.

Shuts down the network subsystem.

Normalizes a string, so that it is suitable for comparison.

Closes a notification.

Closes all notifications registered with the specified handle.

Displays a notification with formatted text.

Returns the UI operations structure to be used when displaying a notification.

Initializes the notify subsystem.

Checks, if passed UI handle is valid.

Displays a notification message to the user.

Returns the title of the column.

since: 3.0.0

Returns whether or not a search result column is visible.

since: 3.0.0

Sets whether or not a search result column is visible.

since: 3.0.0

Displays results from a buddy search. This can be, for example, a window with a list of all found buddies, where you are given the option of adding buddies to your buddy list.

Adds a stock button that will be displayed in the search results dialog.

Adds a plain labelled button that will be displayed in the search results dialog.

Adds a new column to the search result object.

Returns a newly created search result column object. The column defaults to being visible.

Frees a PurpleNotifySearchResults object.

Returns a newly created search results object.

Replace old rows with the new. Reuse an existing window.

Adds a new row of the results to the search results object.

Sets the UI operations structure to be used when displaying a notification.

Uninitializes the notify subsystem.

Opens a URI or somehow presents it to the user.

Displays user information with formatted text, passing information giving the connection and username from which the user information came.

Disable a plugin.

Returns a list of plugins that depend on a particular plugin.

Returns a plugin’s PurplePluginInfo instance.

Returns whether a plugin is an internal plugin. Internal plugins provide required additional functionality to the libpurple core. These plugins must not be shown in plugin lists. Examples of such plugins are in-tree protocol plugins, loaders etc.

Returns whether or not a plugin is currently loaded.

Attempts to load a plugin.

Unloads the specified plugin.

Add a new directory to search for plugins.

Returns a list of all plugins, whether loaded or not.

Finds a plugin with the specified filename (filename with a path).

Finds a plugin with the specified plugin ID.

Returns a list of all loaded plugins.

Initializes the plugin subsystem.

Attempts to load all the plugins in the specified preference key that were loaded when purple last quit.

Forces a refresh of all plugins found in the search paths, and loads plugins that are to be auto-loaded.

Saves the list of loaded plugins to the specified preference key. Plugins that are set to auto-load are not saved.

Uninitializes the plugin subsystem.

Add a new boolean pref.

Add a new integer pref.

Add a new typeless pref.

Add a new path pref.

Add a new path list pref.

Add a new string pref.

Add a new string list pref.

Add a callback to a pref (and its children)

Remove all prefs.

Remove all pref callbacks by handle.

Remove a callback to a pref.

Check if a pref exists.

Get boolean pref value.

Returns a list of children for a pref.

Returns the prefs subsystem handle.

Get integer pref value.

Get path pref value.

Get path list pref value.

Get pref type.

Get string pref value.

Get string list pref value.

Initialize core prefs.

Read preferences.

Remove a pref.

Rename a pref.

Rename a boolean pref, toggling it’s value.

Set boolean pref value.

Set integer pref value.

Set path pref value.

Set path list pref value.

Set string pref value.

Set string list pref value.

Trigger callbacks as if the pref changed.

Trigger callbacks as if the pref changed, taking a PurplePrefCallbackData instead of a name.

since: 2.11.0

Uninitializes the prefs subsystem.

Lookup the id of a primitive status type based on the type. This ID is a unique plain-text name of the status, without spaces.

Lookup the name of a primitive status type based on the type. This name is the plain-English name of the status type. It is usually one or two words.

Lookup the value of a primitive status type based on the id. The ID is a unique plain-text name of the status, without spaces.

Returns a GProxyResolver capable of resolving which proxy to use for this account, if any. This object can be given to a GSocketClient for automatic proxy handling or can be used directly if desired.

Returns configuration of a proxy.

Initializes the proxy subsystem.

Uninitializes the proxy subsystem.

Prompts the user for an action.

va_list version of purple_request_action(); see its documentation.

Adds a function called when notification dialog is closed.

Prompts the user for multiple-choice input.

va_list version of purple_request_choice(); see its documentation.

Closes a request.

Closes all requests registered with the specified handle.

Creates new parameters set initially bound with the PurpleAccount.

Creates new parameters set initially bound with the PurpleConnection.

Creates new parameters set initially bound with the PurpleConversation.

Gets the PurpleAccount associated with the request.

Gets the PurpleConversation associated with the request.

Gets the custom icon associated with the request.

Gets extra actions for the PurpleRequestPage dialog.

Gets the callback for the Help button.

Gets the icon associated with the request.

Gets the parent “donor” for this dialog.

Gets dialog display mode.

Checks, if the text passed to the request is HTML.

Creates new parameters set for the request, which may or may not be used by the UI to display the request.

Increases the reference count on the parameters set.

Sets the PurpleAccount associated with the request, or NULL, if none is.

Sets dialog display mode to compact or default.

Sets the PurpleConversation associated with the request, or NULL, if none is.

Sets the custom icon associated with the request.

Sets extra actions for the PurpleRequestPage dialog.

Sets the callback for the Help button.

Switches the request text to be HTML or not.

Sets the icon associated with the request.

Sets the same parent window for this dialog, as the parent of specified Notify API or Request API dialog UI handle.

Decreases the reference count on the parameters set.

Displays groups of fields for the user to fill in.

Displays a file selector request dialog. Returns the selected filename to the callback. Can be used for either opening a file or saving a file.

Displays a folder select dialog. Returns the selected filename to the callback.

Returns the UI operations structure to be used when displaying a request.

Prompts the user for text input.

Checks, if passed UI handle is valid.

Sets the UI operations structure to be used when displaying a request.

Displays a “please wait” dialog.

Notifies the “please wait” dialog about progress has been made.

Notifies the “please wait” dialog that some progress has been made, but you don’t know how much.

Check if running GNOME.

Check if running KDE.

Returns all saved statuses.

Get the handle for the status subsystem.

Returns the n most popular saved statuses. “Popularity” is determined by when the last time a saved_status was used and how many times it has been used. Transient statuses without messages are not included in the list.

Initializes the status subsystem.

Uninitializes the status subsystem.

Save/store buddy’s alias on server list/roster.

Invite a user to join a chat.

Called when the user requests leaving a chat.

Send a message to a chat.

Protocol should call this function when it retrieves an alias form the server.

Called by a protocol when a message has been received in a chat.

Called by a protocol when an account is invited into a chat.

Called by a protocol when an account has left a chat.

This function is called by the protocol when it receives an IM message.

Called by a protocol when an attempt to join a chat via purple_serv_join_chat() fails.

Called by a protocol when an account has joined a chat.

A protocol should call this when it retrieves a private alias from the server. Private aliases are the aliases the user sets, while public aliases are the aliases or display names that buddies set for themselves.

Receive a typing message from a remote user. Either PURPLE_IM_TYPING or PURPLE_IM_TYPED. If the user has stopped typing then use purple_serv_got_typing_stopped instead.

Called from a protocol when it has received a type stopped.

Move a buddy from one group to another on server.

Send a filename to a given contact.

Sends the message to the user through the required protocol.

Send a typing message to a given user over a given connection.

Connects a signal handler to a signal for a particular object. (Its priority defaults to 0, aka #PURPLE_SIGNAL_PRIORITY_DEFAULT.)

Connects a signal handler to a signal for a particular object.

Disconnects a signal handler from a signal on an object.

Emits a signal.

Emits a signal and returns the first non-NULL return value.

Registers a signal in an instance.

Unregisters a signal in an instance.

Removes all callbacks associated with a receiver handle.

Initializes the signals subsystem.

Uninitializes the signals subsystem.

Unregisters all signals in an instance.

Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available). This is a simple wrapper around g_socket_listener_add_any_inet_port(), except if the user specified a port range in the settings, than a port will be chosen from that range.

Attempts to read the result of PRAGMA user_version which this API uses to store the schema version.

since: 3.0.0

Runs the given migrations in the order they are given. The index of each migration plus 1 is assumed to be the version number of the migration, which means that you can not change the order of the migrations. The reasoning for the addition of 1 is because PRAGMA user_version defaults to 0.

since: 3.0.0

Runs the given migrations in the order they are given. The index of each migration plus 1 is assumed is to be the version number of the migration, which means that you can not change the order of the migrations. The reasoning for the addition of 1 is because PRAGMA user_version defaults to 0.

since: 3.0.0

Get the handle for the status subsystem.

Initializes the status subsystem.

Uninitializes the status subsystem.

Converts seconds into a human-readable form.

Strips all instances of the given character from the given string. The string is modified in place. This is useful for stripping new line characters, for example.

Fills a NUL-terminated string with zeros and frees it.

Duplicates a string and replaces all newline characters from the source string with HTML linebreaks.

Checks if pattern occurs in sequential order in str in a caseless fashion, ignoring characters in between.

since: 3.0.0

Given a string, this replaces one substring with another and returns a newly allocated string.

Splits a tag into its name and value parts.

since: 3.0.0

Removes the underscore characters from a string used identify the mnemonic character.

Unescapes HTML entities to their literal characters and converts “<br>” to “\n”. See purple_unescape_text() for more details.

Unescapes HTML entities to their literal characters in the text. For example “&amp;” is replaced by ‘&’ and so on. Also converts numerical entities (e.g. “&#38;” is also ‘&’).

Encodes a URL into an escaped string.

Case insensitive search for a word in a string. The needle string must be contained in the haystack string and not be immediately preceded or immediately followed by another alphanumeric character.

Compares two UTF-8 strings case-insensitively. This comparison is more expensive than a simple g_utf8_collate() comparison because it calls g_utf8_casefold() on each string, which allocates new strings.

Removes unprintable characters from a UTF-8 string. These characters (in particular low-ASCII characters) are invalid in XML 1.0 and thus are not allowed in XMPP and are rejected by libxml2 by default.

Attempts to convert a string to UTF-8 from an unknown encoding.

Given a string, this replaces all instances of one character with another. This happens inline (the original string IS modified).

Initializes the utility subsystem.

Read the contents of a given file and parse the results into an PurpleXmlNode tree structure. This is intended to be used to read Purple’s cache xml files (xmpp-caps.xml, etc.)

Read the contents of a given file and parse the results into an PurpleXmlNode tree structure. This is intended to be used to read Purple’s config xml files (prefs.xml, pounces.xml, etc.)

Read the contents of a given file and parse the results into an PurpleXmlNode tree structure. This is intended to be used to read Purple’s cache xml files (accounts.xml, etc.)

Define a custom purple settings directory, overriding the default (user’s home directory/.purple)

Uninitializes the util subsystem.

Write a string of data to a file of the given name in the Purple cache directory ($HOME/.cache/purple by default).

Write a string of data to a file of the given name in the Purple config directory ($HOME/.config/purple by default).

Write a string of data to a file of the given name in the Purple data directory ($HOME/.local/share/purple by default).

Checks, if a string is valid.

Duplicates a GValue.

Frees a GValue.

Creates a new GValue of the specified type.

Checks that the libpurple version is compatible with the requested version.

Returns all xfers.

Returns the handle to the file transfer subsystem.

Returns the UI operations structure to be used in all purple file transfers.

Initializes the file transfer subsystem.

Sets the UI operations structure to be used in all purple file transfers.

Uninitializes the file transfer subsystem.

Gets the name of n.

A wrapper for purple_notify_message() that displays an error message.

A wrapper for purple_notify_message() that displays an information message.

A wrapper for purple_notify_message() that displays a warning message.

Extracts the purple major version from abi.

Extracts the purple minor version from abi.

Packs major and minor into an integer to be used as an abi version for gplugin.

since: 3.0.0

A wrapper for purple_request_action() that uses Accept and Cancel buttons.

A wrapper for purple_request_action() that uses OK and Cancel buttons.

A wrapper for purple_request_action() that uses Yes and No buttons.

Checks the version of libpurple being compiled against. See

purple_version_check for a runtime check.

The “extra” part of the version number if anything. Typical values are “devel”, “beta1”, “rc2”, etc.

A global URI prefix for images stored in this subsystem.

The major version of the running libpurple.

The micro version of the running libpurple.

The minor version of the running libpurple.

The priority of a signal connected using purple_signal_connect().

The largest signal priority; signals with this priority will be called last. (This is highest as in numerical value, not as in order of importance.)

The smallest signal priority; signals with this priority will be called first. (This is lowest as in numerical value, not as in order of importance.)

The entire version as a string.