RegistrarEndpoint
The RegistrarEndpoint built-in class defines a SIP endpoint stored in the registrar database of the Live Communications Server. This class can be used to determine the availability and activity level of an endpoint.
Syntax
class RegistrarEndpoint {
string EPID;
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 Live Communications Server. |
||||||||||||||||||||||||||
HasPresence | Data type: bool Specifies |
||||||||||||||||||||||||||
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 Live Communications Server.
|
||||||||||||||||||||||||||
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 Live Communications Server.
|
||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||
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 cached maintained by the registrar. |
||||||||||||||||||||||||||
AllSupportForking | Data type: bool The value is |
||||||||||||||||||||||||||
SupportsForking | bool The value is |