Home > sip.js > UserAgentOptions
Options for UserAgent constructor.
Signature:
export interface UserAgentOptions | Property | Type | Description |
|---|---|---|
| allowLegacyNotifications | boolean |
If true, the user agent will accept out of dialog NOTIFY. |
| authorizationHa1 | string |
Authorization ha1. |
| authorizationPassword | string |
Authorization password. |
| authorizationUsername | string |
Authorization username. |
| autoStart | boolean |
|
| autoStop | boolean |
If true, the user agent calls the stop() method on unload (if running in browser window). |
| contactName | string |
The user portion of user agent's contact URI. |
| contactParams | { [name: string]: string; } |
The URI parameters of the user agent's contact URI. |
| delegate | UserAgentDelegate |
Delegate for UserAgent. |
| displayName | string |
The display name associated with the user agent. |
| forceRport | boolean |
Force adding rport to Via header. |
| hackAllowUnregisteredOptionTags | boolean |
Hack |
| hackIpInContact | boolean | string |
Hack |
| hackViaTcp | boolean |
Hack |
| logBuiltinEnabled | boolean |
Indicates whether log messages should be written to the browser console. |
| logConfiguration | boolean |
If true, constructor logs the user agent configuration. |
| logConnector | LogConnector |
A function which will be called every time a log is generated. |
| logLevel | LogLevel |
Indicates the verbosity level of the log messages. |
| noAnswerTimeout | number |
Number of seconds after which an incoming call is rejected if not answered. |
| preloadedRouteSet | Array<string> |
Adds a Route header(s) to outgoing requests. |
| reconnectionAttempts | number |
|
| reconnectionDelay | number |
|
| sendInitialProvisionalResponse | boolean |
If true, a first provisional response after the 100 Trying will be sent automatically if UAC does not require reliable provisional responses. |
| sessionDescriptionHandlerFactory | SessionDescriptionHandlerFactory |
A factory for generating SessionDescriptionHandler instances. |
| sessionDescriptionHandlerFactoryOptions | object |
Options to passed to sessionDescriptionHandlerFactory. |
| sipExtension100rel | SIPExtension |
Reliable provisional responses. https://tools.ietf.org/html/rfc3262 |
| sipExtensionExtraSupported | Array<string> |
Extra option tags to claim support for. |
| sipExtensionReplaces | SIPExtension |
Replaces header. https://tools.ietf.org/html/rfc3891 |
| sipjsId | string |
An id uniquely identify this user agent instance. |
| transportConstructor | new (logger: Logger, options: any) => Transport |
A constructor function for the user agent's Transport. |
| transportOptions | unknown |
An options bucket object passed to transportConstructor when instantiated. |
| uri | URI |
SIP Addresses-of-Record URI associated with the user agent. |
| userAgentString | string |
User agent string used in the UserAgent header. |
| viaHost | string |
Hostname to use in Via header. |