SIP.RegisterContext

SIP.RegisterContext encapsulates the behavior required to register the UA as well as handle responses, retransmissions, and authentication. It is typically used from within a SIP.UA.

• Configuration Options
  • expires
  • extraContactHeaderParams
  • instanceId
  • params
  • regId
  • registrar
  • Examples
• Instance Variables
• Instance Methods
• Events

Configuration Options

A dictionary of options that is accepted by the RegisterContext. Passed to the UA as registerOptions

expires

Registration expiry time (in seconds) (Number). Default value is 600.

expires: 300

extraContactHeaderParams

Contact header parameters to include on Register requests.

extraContactHeaderParams: ['foo= bar']

instanceId

String indicating the UUID URI to be used as instance ID to identify the UA instance when using GRUU.

instanceId: "uuid:8f1fa16a-1165-4a96-8341-785b1ef24f12"

instanceId: "8f1fa16a-1165-4a96-8341-785b1ef24f12"

params

Advanced configuration options that are typically set automatically by the SIP.UA. Object of various parameters to use on Registration.

regId

number indicating what to use as the regId on Register requests. Enabling this without an instanceId will generate a random instanceId.

registrar

Set the SIP registrar URI. Valid value is a SIP URI without username. Default value is null which means that the registrar URI is taken from the uri parameter (by removing the username).

registrar: 'sip:registrar.mydomain.com'

Examples

// Sends a new message
myUA.message('alice@example.com', 'Hello Alice!');

// When receiving a message, prints it out
myUA.on('message', function (message) {
  console.log(message.body);
});

Instance Variables

SIP.Message inherits its instance attributes from SIP.ClientContext or SIP.ServerContext.

Instance Methods

SIP.Message inherits its instance methods from SIP.ClientContext or SIP.ServerContext.

Events

SIP.Message inherits its events from SIP.ClientContext or SIP.ServerContext.