Phurple Reference

Table of Contents

I. Common

Introduction

1. Requirements

2. Installation

3. Runtime Configuration

4. Examples

II. Class Reference

I. Phurple\Client

Phurple\Client::__construct — Constructor

Phurple\Client::getInstance — Creates new Phurple\Client instance

Phurple\Client::addAccount — Adds a new account to the current client

Phurple\Client::getCoreVersion — Returns the libpurple core version string

Phurple\Client::getProtocols — Returns a list of all valid protocol plugins

Phurple\Client::initInternal — This callback method is called within the Phurple\Client::getInstance

Phurple\Client::loopCallback — This callback method is called within the Phurple\Client::runLoop

Phurple\Client::loopHeartBeat — This callback method is being called as timer

Phurple\Client::runLoop — Creates the main loop

Phurple\Client::setUserDir — Define a custom phurple settings directory.

Phurple\Client::setUiId — Set ui id

Phurple\Client::setDebug — Turn debug on or off, default off

Phurple\Client::writeConv — This callback method writes to the conversation, if implemented

Phurple\Client::writeIM — This callback method writes to the conversation, if implemented

Phurple\Client::onSignedOn — This callback is called at the moment, where the client gets singed on, if implemented

Phurple\Client::deleteAccount — Removes an account from the list of accounts

Phurple\Client::findAccount — Finds the specified account in the accounts list

Phurple\Client::authorizeRequest — This callback method is invoked, when someone adds us to his buddy list

Phurple\Client::iterate — Do a single glib's main loop iteration

Phurple\Client::connect — Connect the client

II. Phurple\Account

Phurple\Account::__construct — Creates a new account

Phurple\Account::addBuddy — Adds a buddy to the server-side buddy list for the specified account

Phurple\Account::removeBuddy — Removes a buddy from the server-side buddy list for the specified account

Phurple\Account::setPassword — Sets the account's password

Phurple\Account::setEnabled — Sets whether or not this account is enabled for some UI

Phurple\Account::isConnected — Returns whether or not the account is connected

Phurple\Account::clearSettings — Clears all protocol-specific settings on an account.

Phurple\Account::set — Sets a protocol-specific setting for an account.

Phurple\Account::get — Gets a protocol-specific setting for an account.

Phurple\Account::isConnecting — Returns whether or not the account is connecting

Phurple\Account::getUserName — Returns the account's username

Phurple\Account::getPassword — Returns the account's password

III. Phurple\Connection

Phurple\Connection::__construct — constructor

Phurple\Connection::getAccount — Returns the connection's account

IV. PhurpleConversation

PhurpleConversation::__construct — Creates a new conversation of the specified type

PhurpleConversation::getName — Returns the specified conversation's name

PhurpleConversation::sendIM — Sends a message to this IM conversation

PhurpleConversation::setAccount — Sets the specified conversation's phurple_account

PhurpleConversation::getAccount — Gets the account of this conversation

V. Phurple\Buddy

Phurple\Buddy::__construct — Creates new buddy

Phurple\Buddy::getAccount — gets buddy's account

Phurple\Buddy::getAlias — gets buddy alias

Phurple\Buddy::getName — Gets buddy name

Phurple\Buddy::getGroup — Gets buddy's group

Phurple\Buddy::isOnline — Checks weither the buddy is online

VI. Phurple\BuddyList

Phurple\BuddyList::__construct — should newer be called

Phurple\BuddyList::load — loads the blist.xml from the homedir

Phurple\BuddyList::addBuddy — adds the buddy to the blist (optionally to the given group in the blist, not implemented yet)

Phurple\BuddyList::addGroup — Adds new group to the blist

Phurple\BuddyList::findBuddy — returns the buddy, if found

Phurple\BuddyList::findGroup — Finds group by name }}}

Phurple\BuddyList::removeBuddy — Removes a buddy from the buddy list

Phurple\BuddyList::removeGroup — Removes an empty group from the buddy list

VII. Phurple\BuddyGroup

Phurple\BuddyGroup::__construct — constructor

Phurple\BuddyGroup::getAccounts — gets all the accounts related to the group

Phurple\BuddyGroup::getName — gets the name of the group

Phurple\BuddyGroup::getOnlineCount — gets the count of the buddies in the group with the status online

Phurple\BuddyGroup::getSize — gets the count of the buddies in the group