Namespace

Purple – 3.0

Purple Universal Chat Library

Version	2.91.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
GPlugin—1.0	GPlugin Plugin Library
	Browse documentation
Pango—1.0	Internationalized text layout and rendering
	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. since: 2.0
AccountManager	A manager that keeps track of all `PurpleAccount`s. 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
Avatar	A representation of an Avatar that is used for accounts, contacts, and conversations. 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
CircularBuffer	A circular buffer implementation. 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.
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.
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
Conversation	A core representation of a conversation between two or more people. since: 2.0
ConversationManager	`PurpleConversationManager` keeps track of all `PurpleConversation`‘s inside of libpurple and allows searching of them. 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
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
HistoryAdapter	`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. unstable since: 3.0
HistoryManager	`PurpleHistoryManager` keeps track of all adapters and emits signals when adapters are added and removed. 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	`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. 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. since: 2.0
PresenceManager	A manager for `PurpleSavedPresence`‘s. 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
ProxyInfo	A representation of a proxy. since: 2.0
RequestField	A request field. 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. 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
SqliteHistoryAdapter	`PurpleSqliteHistoryAdapter` is a class that allows interfacing with an SQLite database to store history. It is a subclass of `PurpleHistoryAdapter`. 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. All user interfaces must create a subclass of this and pass it to `purple_core_init()`. 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

DebugUi	`PurpleDebugUiInterface` defines the behavior that libpurple uses to interface the debug API with the user interface. unstable since: 3.0
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
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

AccountOption	An option for an account. since: 2.0
AccountUserSplit	A username split. since: 2.0
Core	The core instance for libpurple. since: 2.0
KeyValuePair	A key-value pair.
PrefCallbackData	Opaque type to carry callback information. since: 2.11
RequestCommonParameters	Common parameters for UI operations.
RequestUiOps	Request UI operations.
WhiteboardOps	Whiteboard protocol operations.
WhiteboardUiOps	The PurpleWhiteboard UI Operations. since: 2.0
XmlNode	XmlNode is a simplified API for handling XML. An XmlNode represents an XML element and has API for children as well as attributes.

Aliases

Plugin

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

PluginInterface

Represents the plugin interface.

Enumerations

ConnectionError	Possible errors that can cause a connection to be closed.
ConnectionState	A representation of the state of a `PurpleConnection`. since: 2.0
ContactInfoPermission	A representation of whether or not a contact has permission to contact the user. 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
DebugLevel	Available debug levels. since: 2.0
FileTransferState	The possible states that a file transfer can be in.
PrefType	Preference data types. since: 2.0
PresencePrimitive	An enum that is used to determine the type of a `PurplePresence`. unstable since: 3.0
ProxyType	A type of proxy connection. since: 2.0
RequestFeature	Feature flags for the request api.
RequestIconType	Constants to define which kind of icon should be displayed.
RequestType	Request types.
TypingState	Defines the state of a user composing a message. unstable since: 3.0
XmlNodeType	The valid types for an PurpleXmlNode.

Bitfields

PluginInfoFlags

Flags that can be used to treat plugins differently.

unstable since: 3.0

ProtocolOptions

Protocol options.

Error Domains

CreateConversationDetailsError

Error codes returned by create conversation details validation.