RegistrarEndpoint

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

RegistrarEndpoint (MSPL)

The RegistrarEndpoint built-in class defines a SIP endpoint stored in the registrar database of the Office Communications Server. This class can be used to determine the availability and activity level of an endpoint.

Syntax

class RegistrarEndpoint {
string EPID;
string Instance;
bool HasPresence;
int Availability;
int Activity;
int AgeOfPresence;
int StandardMethods;
string ExtraMethods;
int WeightedQValue;
string ContactInfo;
string PresenceDoc;
 bool AllSupportForking;
bool SupportsForking;
}

Fields

The RegistrarEndpoint class defines the following fields.

Field	Description
EPID	Data type: string Specifies an endpoint identifier (EPID) that uniquely identifies this endpoint as registered on the Office Communications Server.
Instance	Data type: string Specifies the unique identifier (GRUU) that is registered by the endpoint. This can be NULL.
HasPresence	Data type: bool Specifies true if an explicit SERVICE Set Presence request was processed for the endpoint or if the endpoint refreshed its registration without setting presence; otherwise, false.
Availability	Data type: int Specifies an aggregate value that indicates the current level of availability for the endpoint. This value is used, along with activity level, in determining presence ranking by the Office Communications Server. Availability aggregate valueDescription 300-999The endpoint is online and active. 200-299The endpoint is connected, but activity is low. 100-199The endpoint's availability is indeterminate. 0-99The endpoint is offline.
Activity	Data type: int Specifies an aggregate value that indicates the current level of activity for the endpoint. This value is used, along with availability level, in determining presence ranking by the Office Communications Server. Activity aggregate valueDescription 800-999Active (online) 700-799Away 600-699Busy 500-599On the Phone 400-499Active (online) 300-399Be Right Back 200-299Idle 150-199Out To Lunch 100-149Away 0-99Offline (no activity)
AgeOfPresence	Data type: int Specifies the number of seconds since the last SERVICE Set Presence request was set for the endpoint.
StandardMethods	Data type: int Specifies the SIP methods supported by the endpoint as a bit mask. This property is useful only as a parameter to SupportsMethod. FlagDescription "REGISTER" 0x00000001The SIP REGISTER method. "SUBSCRIBE" 0x00000002The SIP SUBSCRIBE method. "NOTIFY" 0x00000004The SIP NOTIFY method. "ACK" 0x00000008The SIP ACK method. "BYE" 0x00000010The SIP BYE method. "INVITE" 0x00000040The SIP INVITE method. "OPTIONS" 0x00000080The SIP OPTIONS method. "MESSAGE" 0x00000100The SIP MESSAGE method. "SERVICE" 0x00000400The SIP SERVICE method. "INFO" 0x00000800The SIP INFO method. "REFER" 0x00001000The SIP REFER method. "BENOTIFY" 0x00004000The BENOTIFY method
ExtraMethods	Data type: string Specifies any nonstandard, infrastructure-specific SIP methods supported by the endpoint as a comma-delimited list of method names. For example, "CUSTOM1,CUSTOM2,CUSTOM3".
WeightedQValue	Data type: int Specifies an integer representation of the QValue field from the Contact header of the REGISTER request that generated this endpoint record. The "weighted" form of a number represents the value 1.0 as 0x0100, although only decimal digits are used; for example, 0.92 is represented as 0x0092, and 28 is represented as 0x2800. This allows for comparison of QValues.
ContactInfo	Data type: string Specifies the request URI associated with this endpoint.
PresenceDoc	Data type: string Specifies the XML presence document for a given endpoint. Specifying the presence document forces any call to QueryEndpoints to reference the database rather than the endpoint maintained by the registrar.
AllSupportForking	Data type: bool The value is true only if SupportsForking is true for all endpoints returned by a call to QueryEndpoints; else false.
SupportsForking	Bool The value is true only if the associated endpoint was created with a REGISTER request that included the header Supported:ms-forking; else false.

RegistrarEndpoint