sip.js.useragent.md
October 21, 2022 ยท View on GitHub
UserAgent class
A user agent sends and receives requests using a Transport.
Signature:
export declare class UserAgent
Remarks
A user agent (UA) is associated with a user via the user's SIP address of record (AOR) and acts on behalf of that user to send and receive SIP requests. The user agent can register to receive incoming requests, as well as create and send outbound messages. The user agent also maintains the Transport over which its signaling travels.
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the UserAgent class. |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| configuration | Required<UserAgentOptions> | User agent configuration. | |
| contact | Contact | User agent contact. | |
| data | unknown | Property reserved for use by instance owner. | |
| delegate | UserAgentDelegate | undefined | Delegate. | |
| instanceId | string | User agent instance id. | |
| state | UserAgentState | User agent state. | |
| stateChange | Emitter<UserAgentState> | User agent state change emitter. | |
| transport | Transport | User agent transport. | |
| userAgentCore | UserAgentCore | User agent core. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| getLogger(category, label) | The logger. | |
| getLoggerFactory() | The logger factory. | |
| isConnected() | True if transport is connected. | |
| makeURI(uri) | static | Create a URI instance from a string. |
| reconnect() | Reconnect the transport. | |
| start() | Start the user agent. | |
| stop() | Stop the user agent. |