BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

#include <pjsua.h>

Data Fields

pjsua_buddy_id id
 
pj_str_t uri
 
pj_str_t contact
 
pjsua_buddy_status status
 
pj_str_t status_text
 
pj_bool_t monitor_pres
 
pjsip_evsub_state sub_state
 
const char * sub_state_name
 
unsigned sub_term_code
 
pj_str_t sub_term_reason
 
pjrpid_element rpid
 
pjsip_pres_status pres_status
 
char buf_ [512]
 

Detailed Description

This structure describes buddy info, which can be retrieved by calling pjsua_buddy_get_info().

Field Documentation

◆ id

pjsua_buddy_id pjsua_buddy_info::id

The buddy ID.

◆ uri

pj_str_t pjsua_buddy_info::uri

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

◆ contact

pj_str_t pjsua_buddy_info::contact

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

◆ status

pjsua_buddy_status pjsua_buddy_info::status

Buddy's online status.

◆ status_text

pj_str_t pjsua_buddy_info::status_text

Text to describe buddy's online status.

◆ monitor_pres

pj_bool_t pjsua_buddy_info::monitor_pres

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

◆ sub_state

pjsip_evsub_state pjsua_buddy_info::sub_state

If monitor_pres is enabled, 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 sub_term_reason.

◆ sub_state_name

const char* pjsua_buddy_info::sub_state_name

String representation of subscription state.

◆ sub_term_code

unsigned pjsua_buddy_info::sub_term_code

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 sub_term_reason field.

◆ sub_term_reason

pj_str_t pjsua_buddy_info::sub_term_reason

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

◆ rpid

pjrpid_element pjsua_buddy_info::rpid

Extended RPID information about the person.

◆ pres_status

pjsip_pres_status pjsua_buddy_info::pres_status

Extended presence info.

◆ buf_

char pjsua_buddy_info::buf_[512]

Internal buffer.


The documentation for this struct was generated from the following file:
  • pjsua-lib/pjsua.h

 


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