For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReferenceClick-to-Call
GuidesReferenceClick-to-Call
  • Core
    • Overview
  • Entities
    • SignalWire
    • Address
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • WebRTCCall
      • AddressHistory<TAddress>
      • AudioConstraintsEvent
      • AuthenticateContext
      • Call
      • CallAddress
      • CallCapabilitiesState
      • CallDiagnosticSummary
      • CallError
      • CallNetworkIssue
      • CallNetworkMetrics
      • CallOptions
      • CallParticipant
      • CallSelfParticipant
      • CallState
      • ConstraintFallbackEvent
      • CredentialNoRefreshHandlerWarning
      • CredentialProvider
      • CredentialRefreshFallbackWarning
      • DebugOptions
      • DeviceController
      • DeviceRecoveryEvent
      • DiagnosticEvent
      • DialOptions
      • Directory
      • JSONRPCErrorResponse
      • JSONRPCRequest<TParams>
      • JSONRPCSuccessResponse<TResult>
      • LayoutLayer
      • MediaDirections
      • MediaOptions
      • MediaParamsEvent
      • MemberCapabilities
      • NodeSocketAdapter
      • OnOffCapability
      • PendingRPCOptions
      • PermissionResult
      • PlatformCapabilities
      • PreflightOptions
      • PreflightResult
      • RecoveryEvent
      • SATClaims
      • SDKCredential
      • SDKLogger
      • SelectDeviceOptions
      • SessionDiagnostics
      • SessionState
      • SignalWireOptions
      • Storage
      • StoredDevicePreference
      • TextMessage<TAddress>
      • TransferOptions
      • WebRTCApiProvider
      • WebRTCMediaDevices
  • Web Components
    • Overview
    • sw-audio-level
    • sw-call-controls
    • sw-call-dialpad
    • sw-call-media
    • sw-call-provider
    • sw-call-status
    • sw-call-widget
    • sw-click-to-call
    • sw-device-selector
    • sw-directory
    • sw-local-camera
    • sw-participant-controls
    • sw-participants
    • sw-self-media
    • sw-ui-alert
    • sw-ui-background
    • sw-ui-call-layout
    • sw-ui-content-drawer
    • sw-ui-control-bar
    • sw-ui-dialpad
    • sw-ui-dropup
    • sw-ui-icon
    • sw-ui-modal
    • sw-ui-responsive-container
    • sw-ui-split-button
    • sw-ui-transcript-view
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Properties
EntitiesInterfaces

SignalWireOptions

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Storage

Next
Built with

Options for constructing a SignalWire.

Properties

debug
DebugOptions

Debug options for verbose SDK diagnostics (e.g., { logWsTraffic: true }). See DebugOptions.

logger
SDKLogger | null

Custom logger implementation. Must implement the SDKLogger interface. Pass null to restore the built-in logger. Note: Logger configuration is global — setting it on one instance affects all instances.

logLevel
LogLevel

Log level for the built-in logger. Default: 'warn'. Set to 'debug' for verbose SDK output. Has no effect when a custom logger is provided. Note: Logger configuration is global — setting it on one instance affects all instances. See LogLevel.

persistSession
boolean

Persist the session across page reloads. When true, credential, authorization state, and protocol are stored in localStorage (survives reload). The DPoP key pair is persisted in IndexedDB. On reload, the SDK restores the session from cache without calling credentialProvider.authenticate(). When false (default), session data lives in sessionStorage and is lost on reload. Call destroy() to clear all persisted state (explicit logout).

reconnectAttachedCalls
boolean

Whether to reconnect to previously attached calls.

savePreferences
boolean

Whether to save preferences.

skipConnection
boolean

Skip automatic WebSocket connection on construction.

skipDeviceMonitoring
boolean

Skip monitoring media device changes.

skipRegister
boolean

Skip automatic user registration on construction.

storageImplementation
Storage

Custom storage implementation for persistence. See Storage.

webRTCApiProvider
WebRTCApiProvider

Custom WebRTC API provider. See WebRTCApiProvider.

webSocketConstructor
NodeSocketAdapter | WebSocketAdapter

Custom WebSocket constructor. See NodeSocketAdapter and WebSocketAdapter.