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
  • Extends
  • Properties
  • Methods
  • execute()
EntitiesInterfaces

SessionState

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

SignalWireOptions

Next
Built with

Extended session interface that adds call management and authentication state on top of the narrow ClientSession contract.

Accessible via client.session. Call and CallFactory continue to depend only on the narrow ClientSession interface.

Extends

  • ClientSession

Properties

authenticated
booleanRequired

Current authentication state. Returns true if the session is currently authenticated.

authenticated$
Observable<boolean>Required

Observable that emits true once the session has been authenticated, and false after disconnect.

calls
Call[]Required

Current snapshot of all active calls. See Call.

calls$
Observable<Call[]>Required

Observable stream of all currently active calls (both inbound and outbound). See Call.

incomingCalls
Call[]Required

Current snapshot of active inbound calls. See Call.

incomingCalls$
Observable<Call[]>Required

Observable stream of currently active inbound calls. Filters calls$ to only include calls with direction === 'inbound'. See Call.

Inherited from ClientSession
iceServers
RTCIceServer[] | undefinedRequired

ICE servers configuration for WebRTC peer connections Used by VertoManager to configure RTCPeerConnection. See RTCIceServer.

signalingEvent$
Observable<Record<string, unknown>>Required

Observable stream of incoming signaling events Used by Call to listen for call-related events from the server

Methods

execute()

1execute<T>(request, options?): Promise<T>

Execute an RPC request through the session transport

Type Parameters

Type ParameterDefault type
T extends JSONRPCResponseJSONRPCResponse

Parameters

request
JSONRPCRequestRequired

The JSON-RPC request to execute. See JSONRPCRequest.

options
PendingRPCOptions

Optional RPC execution options (timeout, etc.) See PendingRPCOptions.

Returns

Promise<T>

Promise resolving to the RPC response

Inherited from

ClientSession.execute