sip.js.sessionmanageroptions.md

Home > sip.js > SessionManagerOptions

SessionManagerOptions interface

Options for SessionManager.

Signature:

export interface SessionManagerOptions 

Properties

Property	Modifiers	Type	Description
aor		string	User's SIP Address of Record (AOR).
autoStop		boolean	If true, the user agent calls the stop() method on the window event beforeunload.
delegate		SessionManagerDelegate	Delegate for SessionManager.
iceStopWaitingOnServerReflexive		boolean	Stop waiting for ICE gathering to complete once a server reflexive address is obtained.
managedSessionFactory		ManagedSessionFactory	A factory for generating ManagedSession instances.
maxSimultaneousSessions		number	Maximum number of simultaneous sessions to manage.
media		SessionManagerMedia	Media options.
optionsPingInterval		number	If defined, SIP OPTIONS pings will be sent separated by this interval in seconds.
optionsPingRequestURI		string	The request URI to use for SIP OPTIONS pings.
reconnectionAttempts		number	Maximum number of times to attempt to reconnection.
reconnectionDelay		number	Seconds to wait between reconnection attempts.
registererOptions		RegistererOptions	Options for Registerer.
registererRegisterOptions		RegistererRegisterOptions	Options for register requests (auto register only).
registerGuard		(() => Promise<boolean>) | null	Does nothing if undefined or resolves false. If resolves true, the next regitration attempt will be blocked.
registrationRetry		boolean	If true then registration attempts will be automatically retried when any registration attempts fail or is otherwise rejected.
registrationRetryInterval		number	Time to wait before retrying to send a registration reqeust in seconds.
sendDTMFUsingSessionDescriptionHandler		boolean	Send DTMF using the session description handler (uses RFC 2833 DTMF).
userAgentOptions		UserAgentOptions	Options for UserAgent.