@dialstack/sdk-dev / js/src / DialStackInstanceImpl
Interface: DialStackInstanceImpl
Defined in: sdk/js/src/types/core.ts:853
Internal implementation of DialStackInstance (used by components)
Extends
Properties
account
account: AccountResource;
Defined in: sdk/js/src/types/core.ts:823
Inherited from
addresses
addresses: AddressesResource;
Defined in: sdk/js/src/types/core.ts:827
Inherited from
admin
admin: AdminResource;
Defined in: sdk/js/src/types/core.ts:825
Inherited from
aiAgents
aiAgents: AIAgentsResource;
Defined in: sdk/js/src/types/core.ts:816
Inherited from
audioClips
audioClips: AudioClipsResource;
Defined in: sdk/js/src/types/core.ts:810
Inherited from
availablePhoneNumbers
availablePhoneNumbers: AvailablePhoneNumbersResource;
Defined in: sdk/js/src/types/core.ts:805
Inherited from
DialStackInstance.availablePhoneNumbers
buttonTemplates
buttonTemplates: ButtonTemplatesResource;
Defined in: sdk/js/src/types/core.ts:821
Inherited from
DialStackInstance.buttonTemplates
calls
calls: CallsResource;
Defined in: sdk/js/src/types/core.ts:800
Inherited from
dectBases
dectBases: DECTBasesResource;
Defined in: sdk/js/src/types/core.ts:822
Inherited from
deskphones
deskphones: DeskphonesResource;
Defined in: sdk/js/src/types/core.ts:819
Inherited from
devices
devices: DevicesResource;
Defined in: sdk/js/src/types/core.ts:820
Inherited from
dialPlans
dialPlans: DialPlansResource;
Defined in: sdk/js/src/types/core.ts:811
Inherited from
extensions
extensions: ExtensionsResource;
Defined in: sdk/js/src/types/core.ts:818
Inherited from
hardwareCatalog
hardwareCatalog: HardwareCatalogResource;
Defined in: sdk/js/src/types/core.ts:808
Inherited from
DialStackInstance.hardwareCatalog
hardwareOrders
hardwareOrders: HardwareOrdersResource;
Defined in: sdk/js/src/types/core.ts:807
Inherited from
DialStackInstance.hardwareOrders
livemode
readonly livemode: boolean;
Defined in: sdk/js/src/types/core.ts:713
Whether this instance is operating on live data, from the publishable key's
prefix. pk_test_ keys reach sandbox and demo accounts, which are never
billed; pk_live_ keys reach live accounts only, which the API enforces.
Inherited from
locations
locations: LocationsResource;
Defined in: sdk/js/src/types/core.ts:826
Inherited from
phoneNumberOrders
phoneNumberOrders: PhoneNumberOrdersResource;
Defined in: sdk/js/src/types/core.ts:806
Inherited from
DialStackInstance.phoneNumberOrders
phoneNumbers
phoneNumbers: PhoneNumbersResource;
Defined in: sdk/js/src/types/core.ts:804
Inherited from
DialStackInstance.phoneNumbers
portOrders
portOrders: PortOrdersResource;
Defined in: sdk/js/src/types/core.ts:809
Inherited from
quality
quality: QualityResource;
Defined in: sdk/js/src/types/core.ts:803
Inherited from
queues
queues: QueuesResource;
Defined in: sdk/js/src/types/core.ts:814
Inherited from
remoteNumbers
remoteNumbers: RemoteNumbersResource;
Defined in: sdk/js/src/types/core.ts:801
Inherited from
DialStackInstance.remoteNumbers
ringGroups
ringGroups: RingGroupsResource;
Defined in: sdk/js/src/types/core.ts:813
Inherited from
schedules
schedules: SchedulesResource;
Defined in: sdk/js/src/types/core.ts:812
Inherited from
sharedVoicemailBoxes
sharedVoicemailBoxes: SharedVoicemailBoxesResource;
Defined in: sdk/js/src/types/core.ts:817
Inherited from
DialStackInstance.sharedVoicemailBoxes
users
users: UsersResource;
Defined in: sdk/js/src/types/core.ts:824
Inherited from
voiceApps
voiceApps: VoiceAppsResource;
Defined in: sdk/js/src/types/core.ts:815
Inherited from
voicemails
voicemails: VoicemailsResource;
Defined in: sdk/js/src/types/core.ts:802
Inherited from
Methods
addAppearanceTarget()
addAppearanceTarget(element): void;
Defined in: sdk/js/src/types/core.ts:729
Internal
Register an arbitrary host element to receive dialstack-appearance-update
events when DialStackInstance.update is called. Used internally by
React-only SDK components (no underlying custom element) so they
participate in the same notification path as web components.
Parameters
element
HTMLElement
Returns
void
Inherited from
DialStackInstance.addAppearanceTarget
clientHeader()?
clientHeader?(): string;
Defined in: sdk/js/src/types/core.ts:794
Internal
The current DialStack-Client header value, for DialStack packages that
make their own requests (the softphone's signaling connection).
Returns
string
Inherited from
DialStackInstance.clientHeader
create()
create<T>(tagName): ComponentElement[T];
Defined in: sdk/js/src/types/core.ts:720
Create a new embedded component
Type Parameters
T
T extends ComponentTagName
Parameters
tagName
T
Returns
Inherited from
fetchAllPages()
fetchAllPages<T>(fetchFn): Promise<T[]>;
Defined in: sdk/js/src/types/core.ts:739
Fetch all pages of a paginated list endpoint
Type Parameters
T
T
Parameters
fetchFn
(opts) => Promise<PaginatedResponse<T>>
Returns
Promise<T[]>
Inherited from
DialStackInstance.fetchAllPages
fetchApi()
fetchApi(path, options?): Promise<Response>;
Defined in: sdk/js/src/types/core.ts:737
Make an authenticated API request
Parameters
path
string
options?
RequestInit
Returns
Promise<Response>
Inherited from
getAppearance()
getAppearance(): AppearanceOptions | undefined;
Defined in: sdk/js/src/types/core.ts:775
Get current appearance options
Returns
AppearanceOptions | undefined
Inherited from
DialStackInstance.getAppearance
getClientSecret()
getClientSecret(): Promise<string>;
Defined in: sdk/js/src/types/core.ts:857
Get current client secret
Returns
Promise<string>
logout()
logout(): Promise<void>;
Defined in: sdk/js/src/types/core.ts:735
Log out and clean up the session
Returns
Promise<void>
Inherited from
off()
off<K>(event, handler?): void;
Defined in: sdk/js/src/types/core.ts:745
Unsubscribe from real-time call events
Type Parameters
K
K extends keyof CallEventMap
Parameters
event
K
handler?
CallEventHandler<CallEventMap[K]>
Returns
void
Inherited from
on()
on<K>(event, handler): void;
Defined in: sdk/js/src/types/core.ts:743
Subscribe to real-time call events
Type Parameters
K
K extends keyof CallEventMap
Parameters
event
K
handler
CallEventHandler<CallEventMap[K]>
Returns
void
Inherited from
registerClientComponent()?
registerClientComponent?(packageName, component): void;
Defined in: sdk/js/src/types/core.ts:788
Internal
Report that a package's component was mounted.
Parameters
packageName
string
component
string
Returns
void
Inherited from
DialStackInstance.registerClientComponent
registerClientPackage()?
registerClientPackage?(name, version): void;
Defined in: sdk/js/src/types/core.ts:783
Internal
Report a DialStack package and its version in the DialStack-Client
header. Called by DialStack's own packages (e.g. @dialstack/sdk-react).
Optional so integrators' typed test doubles of the instance still compile.
Parameters
name
string
version
string
Returns
void
Inherited from
DialStackInstance.registerClientPackage
removeAppearanceTarget()
removeAppearanceTarget(element): void;
Defined in: sdk/js/src/types/core.ts:731
Internal
Inverse of DialStackInstance.addAppearanceTarget.
Parameters
element
HTMLElement
Returns
void
Inherited from
DialStackInstance.removeAppearanceTarget
resolveRoutingTarget()
resolveRoutingTarget(target, options?): Promise<
| {
extension_number?: string | null;
id: string;
name: string | null;
timeout_seconds?: number | null;
type: | "voice_app"
| "user"
| "dial_plan"
| "ring_group"
| "queue"
| "shared_voicemail";
}
| null>;
Defined in: sdk/js/src/types/core.ts:757
Resolve a routing target ID to its type, display name, and how long it rings a caller on its own.
timeout_seconds is a ring group's or queue's stored timeout, or the sum
of a user's Find Me / Follow Me step timeouts, and is null for a target
with no ring duration of its own.
Results are cached per instance. Pass refresh: true after the target was
edited elsewhere to fetch it again and replace the cached entry.
Parameters
target
string
options?
refresh?
boolean
Returns
Promise<
| {
extension_number?: string | null;
id: string;
name: string | null;
timeout_seconds?: number | null;
type: | "voice_app"
| "user"
| "dial_plan"
| "ring_group"
| "queue"
| "shared_voicemail";
}
| null>
Inherited from
DialStackInstance.resolveRoutingTarget
routingTargets()
routingTargets(): Promise<RoutingTarget[]>;
Defined in: sdk/js/src/types/core.ts:773
List all selectable inbound-routing targets for the current account by fanning out over the underlying resource lists and merging the results. Convenience aggregation over existing list endpoints — there is no dedicated routing-targets endpoint.
Returns
Promise<RoutingTarget[]>
Inherited from
DialStackInstance.routingTargets
update()
update(updateOptions): void;
Defined in: sdk/js/src/types/core.ts:733
Update appearance for all components
Parameters
updateOptions
Returns
void