User
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
Parameters
http
HTTP request controller used for REST calls.
Returns
User
Properties
addresses
Fabric addresses associated with this user.
appSettings
Application-level settings (display name, permission scopes).
appSettings.displayName
Display name advertised to other participants.
appSettings.scopes
OAuth-style scopes granted to this session.
companyName
Company name.
country
Country code.
displayName
Display name shown to other participants.
User email address.
firstName
First name.
id
Unique user identifier.
jobTitle
Job title.
lastName
Last name.
pushNotificationKey
Push notification key for mobile/web push.
region
Region/state.
satClaims
Filtered SAT claims when the token has special capabilities (e.g., refresh scope). See SATClaims.
timeZone
Time zone offset.
Inherited from Fetchable
fetched$
Observable that emits true once the user profile has been fetched.
fromPath
Origin path or URI captured at construction time, used for routing inbound calls.