BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

#include <presence.hpp>

Public Member Functions

void fromPj (const pjsua_buddy_info &pbi)
 

Data Fields

string uri
 
string contact
 
bool presMonitorEnabled
 
pjsip_evsub_state subState
 
string subStateName
 
pjsip_status_code subTermCode
 
string subTermReason
 
PresenceStatus presStatus
 

Detailed Description

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

Member Function Documentation

◆ fromPj()

void pj::BuddyInfo::fromPj ( const pjsua_buddy_info pbi)

Import from pjsip structure

Field Documentation

◆ uri

string pj::BuddyInfo::uri

The full URI of the buddy, as specified in the configuration.

Referenced by pj::FindBuddyMatch::match().

◆ contact

string pj::BuddyInfo::contact

Buddy's Contact, only available when presence subscription has been established to the buddy.

◆ presMonitorEnabled

bool pj::BuddyInfo::presMonitorEnabled

Flag to indicate that we should monitor the presence information for this buddy (normally yes, unless explicitly disabled).

◆ subState

pjsip_evsub_state pj::BuddyInfo::subState

If presMonitorEnabled is true, this specifies the last state of the presence subscription. If presence subscription session is currently active, the value will be PJSIP_EVSUB_STATE_ACTIVE. If presence subscription request has been rejected, the value will be PJSIP_EVSUB_STATE_TERMINATED, and the termination reason will be specified in subTermReason.

◆ subStateName

string pj::BuddyInfo::subStateName

String representation of subscription state.

◆ subTermCode

pjsip_status_code pj::BuddyInfo::subTermCode

Specifies the last presence subscription termination code. This would return the last status of the SUBSCRIBE request. If the subscription is terminated with NOTIFY by the server, this value will be set to 200, and subscription termination reason will be given in the subTermReason field.

◆ subTermReason

string pj::BuddyInfo::subTermReason

Specifies the last presence subscription termination reason. If presence subscription is currently active, the value will be empty.

◆ presStatus

PresenceStatus pj::BuddyInfo::presStatus

Presence status.


The documentation for this struct was generated from the following file:

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.