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
      • destroy
      • destroyed$
    • WebRTCCall
  • 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
  • Constructors
  • Constructor
  • Properties
  • Accessors
  • Methods
Entities

User

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

destroy

Next
Built with

User is the authenticated user’s profile as returned by the SignalWire fabric. A single instance is created and populated automatically when a SignalWire client connects and the SAT is validated; applications retrieve it via client.user$.

The class exposes the user’s identity (id, email, displayName, name fields), organizational metadata (companyName, country, region, timeZone, jobTitle), and the fabric addresses available for dialing. appSettings carries the display name advertised to other participants and the OAuth-style scopes granted to the current session; satClaims exposes any extended capability claims encoded in the token (e.g. a refresh scope). pushNotificationKey is used by mobile and web-push integrations to register the user for inbound-call notifications.

User extends Fetchable — meaning the profile is populated lazily and fetched$ emits true once the initial fetch completes. There are no mutating methods on this class: the profile is read-only from the SDK’s perspective.

Extends

  • Fetchable<GetUserInfoResponse>

Constructors

Constructor

1new User(http): User

Parameters

http
HTTPRequestControllerRequired

HTTP request controller used for REST calls.

Returns

User

Properties

addresses
GetAddressResponse[]Required

Fabric addresses associated with this user.

appSettings
object

Application-level settings (display name, permission scopes).

appSettings.displayName
string

Display name advertised to other participants.

appSettings.scopes
string[]

OAuth-style scopes granted to this session.

companyName
string

Company name.

country
string

Country code.

displayName
string

Display name shown to other participants.

email
stringRequired

User email address.

firstName
string

First name.

id
stringRequired

Unique user identifier.

jobTitle
string

Job title.

lastName
string

Last name.

pushNotificationKey
stringRequired

Push notification key for mobile/web push.

region
string

Region/state.

satClaims
SATClaims

Filtered SAT claims when the token has special capabilities (e.g., refresh scope). See SATClaims.

timeZone
number

Time zone offset.

Inherited from Fetchable
fetched$
Observable<boolean>Required

Observable that emits true once the user profile has been fetched.

fromPath
stringRequired

Origin path or URI captured at construction time, used for routing inbound calls.

Accessors

destroyed$

Observable that emits when the instance is destroyed

Methods

destroy

Cleans up subscriptions and subjects owned by this instance.