Group PJSUA2_PRES

group PJSUA2_PRES

Typedefs

typedef std::vector<Buddy *> BuddyVector

Warning: deprecated, use BuddyVector2 instead.

Array of buddies.

typedef std::vector<Buddy> BuddyVector2

Array of buddies

struct PresenceStatus
#include <presence.hpp>

This describes presence status.

struct BuddyConfig : public pj::PersistentObject
#include <presence.hpp>

This structure describes buddy configuration when adding a buddy to the buddy list with Buddy::create().

struct BuddyInfo
#include <presence.hpp>

This structure describes buddy info, which can be retrieved by via Buddy::getInfo().

struct OnBuddyEvSubStateParam
#include <presence.hpp>

This structure contains parameters for Buddy::onBuddyEvSubState() callback.

class Buddy
#include <presence.hpp>

Buddy. This is a lite wrapper class for PJSUA-LIB buddy, i.e: this class only maintains one data member, PJSUA-LIB buddy ID, and the methods are simply proxies for PJSUA-LIB buddy operations.

Application can use create() to register a buddy to PJSUA-LIB, and the destructor of the original instance (i.e: the instance that calls create()) will unregister and delete the buddy from PJSUA-LIB. Application must delete all Buddy instances belong to an account before shutting down the account (via Account::shutdown()).

The library will not keep a list of Buddy instances, so any Buddy (or descendant) instances instantiated by application must be maintained and destroyed by the application itself. Any PJSUA2 APIs that return Buddy instance(s) such as Account::enumBuddies2() or Account::findBuddy2() will just return generated copy. All Buddy methods should work normally on this generated copy instance.