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
      • activity$
      • channels$
      • coverUrl$
      • createdAt
      • defaultChannel
      • destroy
      • destroyed$
      • displayName$
      • history
      • id
      • locked$
      • name
      • previewUrl$
      • resourceId$
      • sendText
      • textMessage
      • type$
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • 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

Address

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

activity$

Next
Built with

An Address represents a single directory entry — a contact, room, or any other dialable endpoint exposed by the user’s fabric. Address instances are produced by the Directory returned from SignalWire.directory$; applications do not construct them directly.

Beyond identity metadata (display name, type, cover/preview URLs), Address exposes lazy observables for the entry’s interaction history (history$) and text messages (textMessages$). Subscribing to either kicks off the underlying REST fetch and pages additional results in on demand. Use textMessage to send a new message to the address.

The reactive accessors (displayName$, type$, locked$, etc.) emit when the server pushes an update for this address; their snapshot counterparts (displayName, type, locked) return the most recent cached value. The instance is destroyed when the parent directory page is released.

Extends

  • Destroyable

Constructors

Constructor

1new Address(addressId, conversationManager, addressProvider): Address

Parameters

addressId
stringRequired

Server-assigned ID of the address.

conversationManager
ConversationsProviderRequired

Provider used to load and manage conversations for this address.

addressProvider
AddressProvider<Address>Required

Provider used to load directory entries for this address.

Properties

history$
Observable<EntityCollectionTransformed<GetConversationMessageResponse, AddressHistory<Address>> | undefined>

Observable of call history for this address. Lazily loads conversation data. See AddressHistory.

textMessages$
Observable<EntityCollectionTransformed<GetConversationMessageResponse, TextMessage<Address>> | undefined>

Observable of text messages for this address. Lazily loads conversation data. See TextMessage.

Accessors

activity$

Observable of active call states for this address.

channels$

Observable of available communication channels (audio, video, messaging).

coverUrl$

Observable of the cover image URL.

createdAt

ISO timestamp of when the address was created.

defaultChannel

Default communication channel URI (video for rooms, audio otherwise).

destroyed$

Observable that emits when the instance is destroyed

displayName$

Observable of the human-readable display name.

history

Collection of call history entries for this address, with pagination support.

id

Unique address identifier.

locked$

Observable indicating whether the address (room) is locked.

name

Address name (resource identifier).

previewUrl$

Observable of the preview image URL.

resourceId$

Observable of the underlying resource ID.

textMessage

Collection of text messages for this address, with pagination support.

type$

Observable of the resource type (e.g. 'room', 'subscriber').

Methods

destroy

Cleans up subscriptions and subjects owned by this instance.

sendText

Sends a text message to this address.