@dialstack/sdk-dev / native/src / SoftphoneContextValue
Interface: SoftphoneContextValue
Defined in: sdk/native/src/SoftphoneProvider.tsx:204
The native softphone context: the shared base plus the native-only
locationProvider.
Extends
SoftphoneContextBase
Properties
actions
actions: UseCallActions;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:69
Inherited from
SoftphoneContextBase.actions
activeCall
activeCall: Call | null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:62
Inherited from
SoftphoneContextBase.activeCall
answerCall
answerCall: (call) => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:67
Parameters
call
Returns
void
Inherited from
SoftphoneContextBase.answerCall
audio
audio: UseAudioOutput;
Defined in: sdk/native/src/SoftphoneProvider.tsx:207
calls
calls: Call[];
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:61
Inherited from
SoftphoneContextBase.calls
cancelAttendedTransfer
cancelAttendedTransfer: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:91
Returns
void
Inherited from
SoftphoneContextBase.cancelAttendedTransfer
canMerge
canMerge: boolean;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:99
Whether merging is possible: two connected calls, no transfer, WebAudio present.
Inherited from
SoftphoneContextBase.canMerge
clearError
clearError: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:109
Returns
void
Inherited from
SoftphoneContextBase.clearError
completeAttendedTransfer
completeAttendedTransfer: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:90
Returns
void
Inherited from
SoftphoneContextBase.completeAttendedTransfer
conferenceAudio
conferenceAudio: MediaStream | null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:97
While merged, every remote party mixed — what the local user hears.
Inherited from
SoftphoneContextBase.conferenceAudio
connection
connection: SoftphoneConnectionState;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:54
Inherited from
SoftphoneContextBase.connection
consultCall
consultCall: Call | null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:87
Inherited from
SoftphoneContextBase.consultCall
directory
directory: readonly DirectoryContact[];
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:127
What the transfer / add-call picker lists: the users from
accountDirectory when on, then the host's directory. Empty when neither
has entries.
Inherited from
SoftphoneContextBase.directory
displayNumber
displayNumber: (value) => string;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:111
Parameters
value
string
Returns
string
Inherited from
SoftphoneContextBase.displayNumber
duration
duration: string;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:86
Live m:ss duration of the active call.
Deprecated
Use useCallDuration(activeCall). This field changes on every
clock tick, so it re-renders every useSoftphone() consumer twice a second
during a call, even ones that never read it. It will be removed in the next
major release.
Inherited from
SoftphoneContextBase.duration
emergency
emergency: UseEmergencyBinding;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:106
Inherited from
SoftphoneContextBase.emergency
emergencyManagedByHost
emergencyManagedByHost: boolean;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:107
Inherited from
SoftphoneContextBase.emergencyManagedByHost
hangupConference
hangupConference: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:103
Hang up every leg of the conference (the merged UI shows one Hang up).
Returns
void
Inherited from
SoftphoneContextBase.hangupConference
heldCalls
heldCalls: Call[];
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:66
Inherited from
SoftphoneContextBase.heldCalls
holdConference
holdConference: (held) => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:105
Hold or resume every leg of the conference together.
Parameters
held
boolean
Returns
void
Inherited from
SoftphoneContextBase.holdConference
incomingCalls
incomingCalls: Call[];
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:63
Inherited from
SoftphoneContextBase.incomingCalls
incomingRinging
incomingRinging: boolean;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:65
True while an unanswered inbound call should be audibly ringing.
Inherited from
SoftphoneContextBase.incomingRinging
isMerged
isMerged: boolean;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:95
Inherited from
SoftphoneContextBase.isMerged
lastError
lastError:
| {
code: string;
message: string;
}
| null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:108
Inherited from
SoftphoneContextBase.lastError
layoutVariant
layoutVariant: SoftphoneLayoutVariant;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:121
The size tier the host asked for ('auto' unless pinned).
Inherited from
SoftphoneContextBase.layoutVariant
locationProvider
locationProvider:
| (() => Promise<EmergencyAddressInput>)
| undefined;
Defined in: sdk/native/src/SoftphoneProvider.tsx:206
Host-supplied device-location source for the E911 form, or undefined.
mergeCalls
mergeCalls: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:100
Returns
void
Inherited from
SoftphoneContextBase.mergeCalls
mergedCalls
mergedCalls: Call[];
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:94
The calls bridged into a local three-way conference (empty when not merged).
Inherited from
SoftphoneContextBase.mergedCalls
overlays
overlays: UseCallOverlays;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:77
Internal built-in-UI machinery: the mutually-exclusive keypad/transfer
overlay flags the bundled OngoingCall renders. Not part of the public
softphone API — a custom layout owns its own presentation state and ignores
this. Kept on the shared context (rather than local to OngoingCall) only so
web and React Native can't drift on when the overlays reset.
Inherited from
SoftphoneContextBase.overlays
palette
palette: SoftphonePalette;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:113
Resolved theme palette — computed on both platforms so mobile themes like web.
Inherited from
SoftphoneContextBase.palette
peerInfo
peerInfo: (call) =>
| PeerInfo
| null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:119
The host's PeerInfo for a call, from resolvePeer, or null while it
resolves, when the host has none, or when no resolver is set. The built-in
views read it; a custom UI can too.
Parameters
call
Call | null | undefined
Returns
| PeerInfo
| null
Inherited from
SoftphoneContextBase.peerInfo
placeCall
placeCall: (destination) => Promise<void>;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:92
Parameters
destination
string
Returns
Promise<void>
Inherited from
SoftphoneContextBase.placeCall
splitMerge
splitMerge: () => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:101
Returns
void
Inherited from
SoftphoneContextBase.splitMerge
startAttendedTransfer
startAttendedTransfer: (destination) => Promise<void>;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:89
Parameters
destination
string
Returns
Promise<void>
Inherited from
SoftphoneContextBase.startAttendedTransfer
switchToCall
switchToCall: (call) => void;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:68
Parameters
call
Returns
void
Inherited from
SoftphoneContextBase.switchToCall
t
t: (key) => string;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:110
Parameters
key
| "title"
| "hangUp"
| "transfer"
| "cancel"
| "call"
| "done"
| "answer"
| "split"
| "callWaiting"
| "connecting"
| "disconnected"
| "decline"
| "reconnecting"
| "mute"
| "unmute"
| "destinationPlaceholder"
| "backspace"
| "connectionError"
| "callError"
| "micPermissionError"
| "dismiss"
| "unknownCaller"
| "incomingCall"
| "hold"
| "resume"
| "keypad"
| "transferPlaceholder"
| "transferSend"
| "transferNow"
| "transferConsult"
| "transferComplete"
| "transferConsulting"
| "transferOriginalOnHold"
| "addCall"
| "addCallPlaceholder"
| "addCallSend"
| "directoryLabel"
| "directorySearchPlaceholder"
| "directoryNoMatches"
| "presenceAvailable"
| "presenceOnCall"
| "presenceDoNotDisturb"
| "presenceAway"
| "presenceOffline"
| "enterNumber"
| "chooseFromDirectory"
| "directoryMatches"
| "directoryClearPick"
| "directoryClearSearch"
| "dialTarget"
| "transferToLabel"
| "addCallToLabel"
| "merge"
| "conferenceLabel"
| "stateTrying"
| "stateRinging"
| "stateActive"
| "stateHeld"
| "stateEnded"
| "audioDevices"
| "audioMicrophone"
| "audioSpeaker"
| "audioSystemDefault"
| "audioUnnamedDevice"
| "audioLabelsHidden"
| "audioDevicesUnsupported"
| "audioSpeakerUnsupported"
| "audioMicrophoneLost"
| "switchToCall"
| "heldCallsLabel"
| "emergencyPrompt"
| "emergencyHint"
| "emergencyConfirm"
| "emergencyNewLocation"
| "emergencyUseLocation"
| "emergencyLocating"
| "emergencyNumber"
| "emergencyStreet"
| "emergencyUnit"
| "emergencyCity"
| "emergencyState"
| "emergencyPostalCode"
| "emergencySave"
| "emergencySaving"
| "emergencyBack"
Returns
string
Inherited from
SoftphoneContextBase.t
transferOriginal
transferOriginal: Call | null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:88
Inherited from
SoftphoneContextBase.transferOriginal
webrtcPhone
webrtcPhone:
| DialStackPhone
| null;
Defined in: sdk/react/src/react/softphone/provider/SoftphoneProviderBase.tsx:60
The live WebRTC phone, or null before the first one is constructed. For the
phone-scoped settings that aren't per-call — audio device selection, which
must work whether or not a call is up. Per-call actions belong on actions.
Inherited from
SoftphoneContextBase.webrtcPhone