Namespace

Purple – 3.0

Purple Universal Chat Library

Version	2.96.1
Authors	Pidgin Developers
License	GPL-2.0-or-later
Website	https://keep.imfreedom.org/pidgin/pidgin/
Source	https://keep.imfreedom.org/pidgin/pidgin/

Build

C headers	`purple.h`
pkg-config files	`purple-3`

Dependencies

GLib—2.0	General-purpose, portable utility library.
	Browse documentation
GObject—2.0	The base type system library
	Browse documentation
Gio—2.0	Stream based io library.
	Browse documentation
Pango—1.0	Internationalized text layout and rendering
	Browse documentation
GPlugin—1.0	GPlugin Plugin Library
	Browse documentation
Seagull—1.0	A GObject like API to SQLite
	Browse documentation

Additional documentation

Classes

Account	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. unstable since: 3.0
AccountManager	A manager that keeps track of all `PurpleAccount`s. unstable since: 3.0
AccountManagerBackend	A backend for `PurpleAccountManager` to store its data. unstable since: 3.0
AccountManagerSeagullBackend	A `PurpleAccountManagerBackend` that uses Seagull to store accounts in a SQLite database. unstable since: 3.0
AccountSetting	A setting for an account. unstable since: 3.0
AccountSettingBoolean	A boolean setting for an account. unstable since: 3.0
AccountSettingInt	An integer setting for an account. unstable since: 3.0
AccountSettings	A collection of account settings. unstable since: 3.0
AccountSettingString	A string setting for an account. unstable since: 3.0
AccountSettingStringList	A string list setting for an account. unstable since: 3.0
AddContactRequest	`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. unstable since: 3.0
Attachment	`PurpleAttachment` represents a file attached to a `PurpleMessage`. unstable since: 3.0
Attachments	A collection of `PurpleAttachment`‘s. unstable since: 3.0
AuthorizationRequest	`PurpleAuthorizationRequest` is a data structure that contains all of the information when someone has requested authorization to add you to their contact list. unstable since: 3.0
Badge	`PurpleBadge` is a data structure for badges. They are intended to be used on `PurpleConversationMembers` to display badges like “admin”, “moderator”, “broadcaster”, etc. unstable since: 3.0
BadgeManager	A cache for badges. unstable since: 3.0
Badges	`PurpleBadges` is a collection of `PurpleBadge`s sorted by their priority. This is intended to be used on `PurpleConversationMembers` and perhaps elsewhere to display information like “moderator”, “admin”, “broadcaster”, etc. Items with the highest priority will be at the start of the collection. unstable since: 3.0
ChannelJoinDetails	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. unstable since: 3.0
Command	An object that represents a command. unstable since: 3.0
CommandManager	A manager of `PurpleCommand` objects. unstable since: 3.0
Connection	Represents an active connection on an account. unstable since: 3.0
Contact	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. unstable since: 3.0
ContactInfo	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. unstable since: 3.0
ContactManager	A manager for `PurpleContact`s. unstable since: 3.0
ContactManagerBackend	A back end for loading and storing contacts for `PurpleContactManager`. unstable since: 3.0
ContactManagerSeagullBackend	A Seagull back end for loading and storing contacts for `PurpleContactManager` in a SQLite database. unstable since: 3.0
Contacts	A collection for `PurpleContact`s. unstable since: 3.0
Conversation	A core representation of a conversation between two or more people. unstable since: 3.0
ConversationManager	`PurpleConversationManager` keeps track of all `PurpleConversation`‘s inside of libpurple and allows searching of them. unstable since: 3.0
ConversationManagerBackend	A back end for loading and storing conversations for `PurpleConversationManager`. unstable since: 3.0
ConversationManagerSeagullBackend	A Seagull back end for loading and storing conversations for `PurpleConversationManager` in a SQLite database. unstable since: 3.0
ConversationMember	A conversation member links a `PurpleContactInfo` to a `PurpleConversation` as well as any data that is unique to the link. unstable since: 3.0
ConversationMembers	A collection of `PurpleConversationMember`s. unstable since: 3.0
Core	The core instance for libpurple. unstable since: 3.0
CreateConversationDetails	The details that are necessary for a `PurpleProtocol` to create a conversation. unstable since: 3.0
CredentialManager	Purple Credential Manager is the main API access to different credential providers. Providers are added to the manager and then the user can choose which provider to use. unstable since: 3.0
CredentialProvider	`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`. unstable since: 3.0
FileTransfer	A peer to peer file transfer object. unstable since: 3.0
FileTransferManager	Keeps track of the `PurpleFileTransfer`‘s that have been added to it and propagates all of their signals. unstable since: 3.0
IdleManager	The idle manager keeps track of multiple idle sources and aggregates them to the oldest one to report a global idle state. unstable since: 3.0
Image	A container for raw image data. It doesn’t manipulate the image data, it just stores it in its binary format - png, jpeg etc. unstable since: 3.0
Message	`PurpleMessage` represents any message passed between users in libpurple. unstable since: 3.0
Messages	A read-only collection of `PurpleMessage`‘s and the `PurpleConversation` that they belong to. unstable since: 3.0
NoopCredentialProvider	`PurpleNoopCredentialProvider` is a `PurpleCredentialProvider` that does not actually provider credentials. It is used to implement the default behavior of requiring users to input passwords. unstable since: 3.0
Notification	An object that represents a notification. unstable since: 3.0
NotificationAddContact	A `PurpleNotification` for `PurpleAddContactRequest`s. unstable since: 3.0
NotificationAuthorizationRequest	A `PurpleNotification` for `PurpleAuthorizationRequest`s. unstable since: 3.0
NotificationConnectionError	A `PurpleNotification` for connection errors on `PurpleAccount`. unstable since: 3.0
NotificationLink	A `PurpleNotification` that contains a link for more information. unstable since: 3.0
NotificationManager	Purple Notification Manager manages all notifications between protocols and plugins and how the user interface interacts with them. unstable since: 3.0
Person	A collection of `PurpleContactInfo` that contains a user selectable custom avatar and alias. unstable since: 3.0
PluginInfo	`PurplePluginInfo` is a `GPluginPluginInfo` subclass that adds additional libpurple specific properties. unstable since: 3.0
Presence	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. unstable since: 3.0
PresenceManager	A manager for `PurpleSavedPresence`‘s. unstable since: 3.0
PresenceManagerBackend	A back end for loading and storing `PurpleSavedPresence` for `PurplePresenceManager`. unstable since: 3.0
PresenceManagerSeagullBackend	A Seagull back end for loading and storing saved presences for `PurplePresenceManager` in a SQLite database. unstable since: 3.0
Protocol	`PurpleProtocol` is the base type for all protocols in libpurple. unstable since: 3.0
ProtocolManager	`PurpleProtocolManager` keeps track of all protocols and emits signals when protocols are added and removed. unstable since: 3.0
QrCode	An object containing information about a QR Code. unstable since: 3.0
RequestField	The base class for all request fields. unstable since: 3.0
RequestFieldAccount	An account request field. unstable since: 3.0
RequestFieldBool	A boolean request field. unstable since: 3.0
RequestFieldChoice	A choice request field which is often represented as a drop down or group of radio buttons. unstable since: 3.0
RequestFieldImage	An image request field. unstable since: 3.0
RequestFieldInt	An integer request field. unstable since: 3.0
RequestFieldLabel	A label request field. unstable since: 3.0
RequestFieldList	A list request field. unstable since: 3.0
RequestFieldString	A string request field. unstable since: 3.0
RequestGroup	A group of fields with a title. unstable since: 3.0
RequestPage	Multiple fields request data. unstable since: 3.0
SavedPresence	A data structure used to save a presence. unstable since: 3.0
ScheduledTask	An object that represents a scheduled task. unstable since: 3.0
Scheduler	An object that manages a collection of `PurpleScheduledTask`. unstable since: 3.0
SchedulerBackend	An object that manages a collection of `PurpleScheduledTask`. unstable since: 3.0
Tags	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. Also, `foo:` is still considered a name and value, but the value is an empty string. unstable since: 3.0
Ui	An abstract class representing a user interface. unstable since: 3.0
Whiteboard	A abstract whiteboard object. unstable since: 3.0
WhiteboardManager	`PurpleWhiteboardManager` keeps track of all whiteboards and emits signals when they are added and removed. unstable since: 3.0

Interfaces

ProtocolContacts	`PurpleProtocolContacts` provides methods for interacting with remote contacts. unstable since: 3.0
ProtocolConversation	This interface defines the behavior for interacting with conversations at the protocol layer. These methods will primarily be called by the user interface. unstable since: 3.0
ProtocolDirectory	Methods for directory listing in protocols. unstable since: 3.0
ProtocolFileTransfer	`PurpleProtocolFileTransfer` provides methods for sending and receiving files. unstable since: 3.0
ProtocolRoster	The `PurpleProtocolRoster` interface defines the behavior to tell a protocol when the users wants to manage contacts on the server side roster. unstable since: 3.0
ProtocolWhiteboard	The `PurpleProtocolWhiteboard` interface defines the behavior of a protocol’s whiteboard interface. unstable since: 3.0

Structs

KeyValuePair

A key-value pair.

WhiteboardUiOps

The PurpleWhiteboard UI Operations.

unstable since: 3.0

Enumerations

AccountManagerBackendError	Error codes returned by `PurpleAccountManagerBackend`. unstable since: 3.0
AccountManagerSeagullBackendError	Error codes returned by `PurpleAccountManagerSeagullBackend`. unstable since: 3.0
ConnectionError	Possible errors that can cause a connection to be closed. unstable since: 3.0
ConnectionState	A representation of the state of a `PurpleConnection`. unstable since: 3.0
ContactInfoPermission	A representation of whether or not a contact has permission to contact the user. unstable since: 3.0
ContactManagerBackendError	Error codes returned by `PurpleContactManagerBackend`. unstable since: 3.0
ConversationManagerBackendError	Error codes returned by `PurpleConversationManagerBackend`. unstable since: 3.0
ConversationNotifyLevel	The level for which messages should present notifications. unstable since: 3.0
ConversationType	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! unstable since: 3.0
CoreError	Error codes returned by the core. unstable since: 3.0
CredentialManagerError	Error codes for the credential manager. unstable since: 3.0
CredentialProviderError	Error codes returned by `PurpleCredentialProvider`. unstable since: 3.0
DebugLevel	Available debug levels. unstable since: 3.0
FileTransferState	The possible states that a file transfer can be in. unstable since: 3.0
NoopCredentialProviderError	Error codes for the no operation credential provider. unstable since: 3.0
PresenceManagerBackendError	Error codes returned by `PurplePresenceManagerBackend`. unstable since: 3.0
PresencePrimitive	An enumeration that is used to determine the type of a `PurplePresence`. unstable since: 3.0
ScheduledTaskState	The possible states that a task can be in. unstable since: 3.0
SchedulerBackendError	Error codes returned by `PurpleSchedulerBackend`. unstable since: 3.0
SchedulerError	Error codes returned by the scheduler. unstable since: 3.0
TypingState	Defines the state of a user composing a message. unstable since: 3.0
UiError	Error codes returned by the user interface abstraction. unstable since: 3.0

Bitfields

PluginInfoFlags

Flags that can be used to treat plugins differently.

unstable since: 3.0

Error Domains

AccountError	Error codes returned by `PurpleAccount`. unstable since: 3.0
CreateConversationDetailsError	Error codes returned by create conversation details validation. unstable since: 3.0
ProtocolContactsError	Error codes returned by `PurpleProtocolContacts`. unstable since: 3.0
ProtocolConversationError	Error codes returned by `PurpleProtocolConversation`. unstable since: 3.0
ProtocolDirectoryError	Error codes returned by protocol directory. unstable since: 3.0
ProtocolError	Error codes returned by protocols. unstable since: 3.0
ProtocolManagerError	Error codes returned by `PurpleProtocolManager`. unstable since: 3.0
ScheduledTaskError	Error codes returned by scheduled tasks. unstable since: 3.0
WhiteboardManagerError	Error codes returned by `PurpleWhiteboardManager`. unstable since: 3.0

Callbacks

MenuWalkFunc

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.

unstable since: 3.0

RequestFieldValidator

A callback to check whether a field is valid.

unstable since: 3.0

Functions

action_command_new	Create a new `action` command. unstable since: 3.0
cache_dir	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. unstable since: 3.0
config_dir	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. unstable since: 3.0
data_dir	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. unstable since: 3.0
email_is_valid	Checks if the given email address is syntactically valid. unstable since: 3.0
get_locale_dir	Gets the search directory for translations. unstable since: 3.0
get_option_group	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. unstable since: 3.0
markup_linkify	Adds the necessary HTML code to turn URIs into HTML links in a string. unstable since: 3.0
markup_strip_html	Strips HTML tags from a string. unstable since: 3.0
menu_copy	Creates a full copy of `model` as a new `GMenu`. If `model` was not a `GMenu` instance, any additional functionality will be lost. unstable since: 3.0
menu_populate_dynamic_targets	Updates `menu` by adding a target property when an item with an attribute named “dynamic-target” is found. unstable since: 3.0
menu_populate_dynamic_targetsv	Updates `menu` by adding a target property when an item with an attribute named “dynamic-target” is found. unstable since: 3.0
menu_walk	Recursively calls `func` for each item in `model` and all of its children. unstable since: 3.0
plugins_init	Initializes the plugin subsystem. unstable since: 3.0
plugins_load_saved	Attempts to load all the plugins that were loaded when purple last quit. unstable since: 3.0
plugins_refresh	Forces a refresh of all plugins found in the search paths, and loads plugins that are to be auto-loaded. unstable since: 3.0
plugins_save_loaded	Saves the list of loaded plugins. unstable since: 3.0
plugins_uninit	Uninitializes the plugin subsystem. unstable since: 3.0
say_command_new	Creates a new `say` command. unstable since: 3.0
strreplace	Given a string, this replaces one substring with another and returns a newly allocated string. unstable since: 3.0
tag_split	Splits a tag into its name and value parts. unstable since: 3.0
unescape_html	Unescapes HTML entities to their literal characters and converts “<br>” to “\n”. See `purple_unescape_text()` for more details. unstable since: 3.0
unescape_text	Unescapes HTML entities to their literal characters in the text. For example “&” is replaced by ‘&’ and so on. Also converts numerical entities (e.g. “&” is also ‘&’). unstable since: 3.0
utf8_strcasecmp	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. unstable since: 3.0
util_init	Initializes the utility subsystem. unstable since: 3.0
util_set_user_dir	Define a custom purple settings directory, overriding the default (user’s home directory/.purple). unstable since: 3.0
util_uninit	Uninitializes the util subsystem. unstable since: 3.0
version_check	Checks that the libpurple version is compatible with the requested version. unstable since: 3.0

Function Macros

PLUGIN_ABI_MAJOR_VERSION	Extracts the purple major version from `abi`. unstable since: 3.0
PLUGIN_ABI_MINOR_VERSION	Extracts the purple minor version from `abi`. unstable since: 3.0
PLUGIN_ABI_VERSION	Packs `major` and `minor` into an integer to be used as an abi version for gplugin. unstable since: 3.0
VERSION_CHECK	Checks the version of libpurple being compiled against. See purple_version_check for a runtime check. unstable since: 3.0

Constants

API_MAJOR_VERSION	The major version of the API.
EXTRA_VERSION	The “extra” part of the version number if anything. Typical values are “devel”, “beta1”, “rc2”, etc.
MAJOR_VERSION	The major version of the running libpurple.
MENU_ATTRIBUTE_DYNAMIC_TARGET	A constant to help when defining actions that have a dynamic-target value.
MICRO_VERSION	The micro version of the running libpurple.
MINOR_VERSION	The minor version of the running libpurple.
VERSION	The entire version as a string.
VERSION_MIN_REQUIRED	A macro that should be defined by the user prior to including the `purple.h` header.

Dependencies

Additional documentation

Classes

Interfaces

Structs

Enumerations

Bitfields

Error Domains

Callbacks

Functions

Function Macros

purple_version_check for a runtime check.

Constants