From 75634927c2bbca280800444a097389f563977c69 Mon Sep 17 00:00:00 2001 From: Haythem Farhat Date: Wed, 9 Oct 2024 13:55:35 +0100 Subject: [PATCH] chore: update doc generator links --- packages/js/docs/ts/README.md | 12 +-- packages/js/docs/ts/classes/Call.md | 52 +++++------ packages/js/docs/ts/classes/TelnyxRTC.md | 91 +++++++++++-------- .../js/docs/ts/interfaces/ICallOptions.md | 52 +++++------ .../js/docs/ts/interfaces/IClientOptions.md | 12 +-- .../js/docs/ts/interfaces/INotification.md | 8 +- packages/js/typedoc.json | 5 +- 7 files changed, 121 insertions(+), 111 deletions(-) diff --git a/packages/js/docs/ts/README.md b/packages/js/docs/ts/README.md index c0d7ee5b..f44b9f2a 100644 --- a/packages/js/docs/ts/README.md +++ b/packages/js/docs/ts/README.md @@ -1,20 +1,18 @@ -# @telnyx/webrtc - ## Table of contents ### Call Classes -- [Call](classes/Call.md) +- [Call](./classes/Call.md) ### Client Classes -- [TelnyxRTC](classes/TelnyxRTC.md) +- [TelnyxRTC](./classes/TelnyxRTC.md) ### Notification Interfaces -- [INotification](interfaces/INotification.md) +- [INotification](./interfaces/INotification.md) ### Other Interfaces -- [ICallOptions](interfaces/ICallOptions.md) -- [IClientOptions](interfaces/IClientOptions.md) +- [ICallOptions](./interfaces/ICallOptions.md) +- [IClientOptions](./interfaces/IClientOptions.md) diff --git a/packages/js/docs/ts/classes/Call.md b/packages/js/docs/ts/classes/Call.md index 40ffd720..94b739c8 100644 --- a/packages/js/docs/ts/classes/Call.md +++ b/packages/js/docs/ts/classes/Call.md @@ -1,5 +1,3 @@ -# Class: Call - A `Call` is the representation of an audio or video call between two browsers, SIP clients or phone numbers. The `call` object is created whenever a new call is initiated, either by you or the @@ -54,37 +52,37 @@ call.muteAudio(); ### Properties -- [direction](Call.md#direction) -- [id](Call.md#id) -- [prevState](Call.md#prevstate) -- [state](Call.md#state) +- [direction](./classes/Call.md#direction) +- [id](./classes/Call.md#id) +- [prevState](./classes/Call.md#prevstate) +- [state](./classes/Call.md#state) ### Accessors -- [localStream](Call.md#localstream) -- [remoteStream](Call.md#remotestream) -- [telnyxIDs](Call.md#telnyxids) +- [localStream](./classes/Call.md#localstream) +- [remoteStream](./classes/Call.md#remotestream) +- [telnyxIDs](./classes/Call.md#telnyxids) ### Methods -- [answer](Call.md#answer) -- [deaf](Call.md#deaf) -- [dtmf](Call.md#dtmf) -- [getStats](Call.md#getstats) -- [hold](Call.md#hold) -- [muteAudio](Call.md#muteaudio) -- [muteVideo](Call.md#mutevideo) -- [setAudioInDevice](Call.md#setaudioindevice) -- [setAudioOutDevice](Call.md#setaudiooutdevice) -- [setVideoDevice](Call.md#setvideodevice) -- [toggleAudioMute](Call.md#toggleaudiomute) -- [toggleDeaf](Call.md#toggledeaf) -- [toggleHold](Call.md#togglehold) -- [toggleVideoMute](Call.md#togglevideomute) -- [undeaf](Call.md#undeaf) -- [unhold](Call.md#unhold) -- [unmuteAudio](Call.md#unmuteaudio) -- [unmuteVideo](Call.md#unmutevideo) +- [answer](./classes/Call.md#answer) +- [deaf](./classes/Call.md#deaf) +- [dtmf](./classes/Call.md#dtmf) +- [getStats](./classes/Call.md#getstats) +- [hold](./classes/Call.md#hold) +- [muteAudio](./classes/Call.md#muteaudio) +- [muteVideo](./classes/Call.md#mutevideo) +- [setAudioInDevice](./classes/Call.md#setaudioindevice) +- [setAudioOutDevice](./classes/Call.md#setaudiooutdevice) +- [setVideoDevice](./classes/Call.md#setvideodevice) +- [toggleAudioMute](./classes/Call.md#toggleaudiomute) +- [toggleDeaf](./classes/Call.md#toggledeaf) +- [toggleHold](./classes/Call.md#togglehold) +- [toggleVideoMute](./classes/Call.md#togglevideomute) +- [undeaf](./classes/Call.md#undeaf) +- [unhold](./classes/Call.md#unhold) +- [unmuteAudio](./classes/Call.md#unmuteaudio) +- [unmuteVideo](./classes/Call.md#unmutevideo) ## Properties diff --git a/packages/js/docs/ts/classes/TelnyxRTC.md b/packages/js/docs/ts/classes/TelnyxRTC.md index 2f51a917..74e0d01e 100644 --- a/packages/js/docs/ts/classes/TelnyxRTC.md +++ b/packages/js/docs/ts/classes/TelnyxRTC.md @@ -1,5 +1,3 @@ -# Class: TelnyxRTC - The `TelnyxRTC` client connects your application to the Telnyx backend, enabling you to make outgoing calls and handle incoming calls. @@ -44,39 +42,40 @@ client.off('telnyx.notification'); ### Constructors -- [constructor](TelnyxRTC.md#constructor) +- [constructor](./classes/TelnyxRTC.md#constructor) ### Accessors -- [connected](TelnyxRTC.md#connected) -- [localElement](TelnyxRTC.md#localelement) -- [mediaConstraints](TelnyxRTC.md#mediaconstraints) -- [remoteElement](TelnyxRTC.md#remoteelement) -- [speaker](TelnyxRTC.md#speaker) +- [connected](./classes/TelnyxRTC.md#connected) +- [localElement](./classes/TelnyxRTC.md#localelement) +- [mediaConstraints](./classes/TelnyxRTC.md#mediaconstraints) +- [remoteElement](./classes/TelnyxRTC.md#remoteelement) +- [speaker](./classes/TelnyxRTC.md#speaker) ### Methods -- [checkPermissions](TelnyxRTC.md#checkpermissions) -- [connect](TelnyxRTC.md#connect) -- [disableMicrophone](TelnyxRTC.md#disablemicrophone) -- [disableWebcam](TelnyxRTC.md#disablewebcam) -- [disconnect](TelnyxRTC.md#disconnect) -- [enableMicrophone](TelnyxRTC.md#enablemicrophone) -- [enableWebcam](TelnyxRTC.md#enablewebcam) -- [getAudioInDevices](TelnyxRTC.md#getaudioindevices) -- [getAudioOutDevices](TelnyxRTC.md#getaudiooutdevices) -- [getDeviceResolutions](TelnyxRTC.md#getdeviceresolutions) -- [getDevices](TelnyxRTC.md#getdevices) -- [getIsRegistered](TelnyxRTC.md#getisregistered) -- [getVideoDevices](TelnyxRTC.md#getvideodevices) -- [logout](TelnyxRTC.md#logout) -- [newCall](TelnyxRTC.md#newcall) -- [off](TelnyxRTC.md#off) -- [on](TelnyxRTC.md#on) -- [setAudioSettings](TelnyxRTC.md#setaudiosettings) -- [setVideoSettings](TelnyxRTC.md#setvideosettings) -- [webRTCInfo](TelnyxRTC.md#webrtcinfo) -- [webRTCSupportedBrowserList](TelnyxRTC.md#webrtcsupportedbrowserlist) +- [checkPermissions](./classes/TelnyxRTC.md#checkpermissions) +- [connect](./classes/TelnyxRTC.md#connect) +- [disableMicrophone](./classes/TelnyxRTC.md#disablemicrophone) +- [disableWebcam](./classes/TelnyxRTC.md#disablewebcam) +- [disconnect](./classes/TelnyxRTC.md#disconnect) +- [enableMicrophone](./classes/TelnyxRTC.md#enablemicrophone) +- [enableWebcam](./classes/TelnyxRTC.md#enablewebcam) +- [getAudioInDevices](./classes/TelnyxRTC.md#getaudioindevices) +- [getAudioOutDevices](./classes/TelnyxRTC.md#getaudiooutdevices) +- [getDeviceResolutions](./classes/TelnyxRTC.md#getdeviceresolutions) +- [getDevices](./classes/TelnyxRTC.md#getdevices) +- [getIsRegistered](./classes/TelnyxRTC.md#getisregistered) +- [getVideoDevices](./classes/TelnyxRTC.md#getvideodevices) +- [logout](./classes/TelnyxRTC.md#logout) +- [newCall](./classes/TelnyxRTC.md#newcall) +- [off](./classes/TelnyxRTC.md#off) +- [on](./classes/TelnyxRTC.md#on) +- [onNetworkClose](./classes/TelnyxRTC.md#onnetworkclose) +- [setAudioSettings](./classes/TelnyxRTC.md#setaudiosettings) +- [setVideoSettings](./classes/TelnyxRTC.md#setvideosettings) +- [webRTCInfo](./classes/TelnyxRTC.md#webrtcinfo) +- [webRTCSupportedBrowserList](./classes/TelnyxRTC.md#webrtcsupportedbrowserlist) ## Constructors @@ -90,7 +89,7 @@ Creates a new `TelnyxRTC` instance with the provided options. | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`IClientOptions`](../interfaces/IClientOptions.md) | Options for initializing a client | +| `options` | [`IClientOptions`](./interfaces/IClientOptions.md) | Options for initializing a client | **`Examples`** @@ -850,7 +849,7 @@ ___ ### newCall -▸ **newCall**(`options`): [`Call`](Call.md) +▸ **newCall**(`options`): [`Call`](./classes/Call.md) Makes a new outbound call. @@ -858,11 +857,11 @@ Makes a new outbound call. | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`ICallOptions`](../interfaces/ICallOptions.md) | Options object for a new call. | +| `options` | [`ICallOptions`](./interfaces/ICallOptions.md) | Options object for a new call. | #### Returns -[`Call`](Call.md) +[`Call`](./classes/Call.md) The new outbound `Call` object. @@ -910,7 +909,7 @@ ___ ### off -▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](./classes/TelnyxRTC.md) Removes an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed. @@ -924,7 +923,7 @@ If no handler parameter is passed, all listeners for that event will be removed. #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](./classes/TelnyxRTC.md) The client object itself. @@ -956,7 +955,7 @@ ___ ### on -▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](./classes/TelnyxRTC.md) Attaches an event handler for a specific type of event. @@ -980,7 +979,7 @@ Attaches an event handler for a specific type of event. #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](./classes/TelnyxRTC.md) The client object itself. @@ -1004,6 +1003,24 @@ TelnyxRTCClient.on ___ +### onNetworkClose + +▸ **onNetworkClose**(): `void` + +Callback when the ws connection is going to close or get an error + +#### Returns + +`void` + +void + +#### Inherited from + +TelnyxRTCClient.onNetworkClose + +___ + ### setAudioSettings ▸ **setAudioSettings**(`settings`): `Promise`\<`MediaTrackConstraints`\> diff --git a/packages/js/docs/ts/interfaces/ICallOptions.md b/packages/js/docs/ts/interfaces/ICallOptions.md index 91cd0c21..005ca1a1 100644 --- a/packages/js/docs/ts/interfaces/ICallOptions.md +++ b/packages/js/docs/ts/interfaces/ICallOptions.md @@ -1,5 +1,3 @@ -# Interface: ICallOptions - ICallOptions ICallOptions @@ -7,31 +5,31 @@ ICallOptions ### Properties -- [audio](ICallOptions.md#audio) -- [callerName](ICallOptions.md#callername) -- [callerNumber](ICallOptions.md#callernumber) -- [camId](ICallOptions.md#camid) -- [clientState](ICallOptions.md#clientstate) -- [customHeaders](ICallOptions.md#customheaders) -- [debug](ICallOptions.md#debug) -- [debugOutput](ICallOptions.md#debugoutput) -- [destinationNumber](ICallOptions.md#destinationnumber) -- [iceServers](ICallOptions.md#iceservers) -- [id](ICallOptions.md#id) -- [localElement](ICallOptions.md#localelement) -- [localStream](ICallOptions.md#localstream) -- [mediaSettings](ICallOptions.md#mediasettings) -- [micId](ICallOptions.md#micid) -- [onNotification](ICallOptions.md#onnotification) -- [preferred\_codecs](ICallOptions.md#preferred_codecs) -- [remoteElement](ICallOptions.md#remoteelement) -- [remoteStream](ICallOptions.md#remotestream) -- [speakerId](ICallOptions.md#speakerid) -- [telnyxCallControlId](ICallOptions.md#telnyxcallcontrolid) -- [telnyxLegId](ICallOptions.md#telnyxlegid) -- [telnyxSessionId](ICallOptions.md#telnyxsessionid) -- [useStereo](ICallOptions.md#usestereo) -- [video](ICallOptions.md#video) +- [audio](./interfaces/ICallOptions.md#audio) +- [callerName](./interfaces/ICallOptions.md#callername) +- [callerNumber](./interfaces/ICallOptions.md#callernumber) +- [camId](./interfaces/ICallOptions.md#camid) +- [clientState](./interfaces/ICallOptions.md#clientstate) +- [customHeaders](./interfaces/ICallOptions.md#customheaders) +- [debug](./interfaces/ICallOptions.md#debug) +- [debugOutput](./interfaces/ICallOptions.md#debugoutput) +- [destinationNumber](./interfaces/ICallOptions.md#destinationnumber) +- [iceServers](./interfaces/ICallOptions.md#iceservers) +- [id](./interfaces/ICallOptions.md#id) +- [localElement](./interfaces/ICallOptions.md#localelement) +- [localStream](./interfaces/ICallOptions.md#localstream) +- [mediaSettings](./interfaces/ICallOptions.md#mediasettings) +- [micId](./interfaces/ICallOptions.md#micid) +- [onNotification](./interfaces/ICallOptions.md#onnotification) +- [preferred\_codecs](./interfaces/ICallOptions.md#preferred_codecs) +- [remoteElement](./interfaces/ICallOptions.md#remoteelement) +- [remoteStream](./interfaces/ICallOptions.md#remotestream) +- [speakerId](./interfaces/ICallOptions.md#speakerid) +- [telnyxCallControlId](./interfaces/ICallOptions.md#telnyxcallcontrolid) +- [telnyxLegId](./interfaces/ICallOptions.md#telnyxlegid) +- [telnyxSessionId](./interfaces/ICallOptions.md#telnyxsessionid) +- [useStereo](./interfaces/ICallOptions.md#usestereo) +- [video](./interfaces/ICallOptions.md#video) ## Properties diff --git a/packages/js/docs/ts/interfaces/IClientOptions.md b/packages/js/docs/ts/interfaces/IClientOptions.md index 0e73f389..d0ffe00f 100644 --- a/packages/js/docs/ts/interfaces/IClientOptions.md +++ b/packages/js/docs/ts/interfaces/IClientOptions.md @@ -1,5 +1,3 @@ -# Interface: IClientOptions - IClientOptions IClientOptions @@ -7,11 +5,11 @@ IClientOptions ### Properties -- [login](IClientOptions.md#login) -- [login\_token](IClientOptions.md#login_token) -- [password](IClientOptions.md#password) -- [ringbackFile](IClientOptions.md#ringbackfile) -- [ringtoneFile](IClientOptions.md#ringtonefile) +- [login](./interfaces/IClientOptions.md#login) +- [login\_token](./interfaces/IClientOptions.md#login_token) +- [password](./interfaces/IClientOptions.md#password) +- [ringbackFile](./interfaces/IClientOptions.md#ringbackfile) +- [ringtoneFile](./interfaces/IClientOptions.md#ringtonefile) ## Properties diff --git a/packages/js/docs/ts/interfaces/INotification.md b/packages/js/docs/ts/interfaces/INotification.md index 81fcc55f..2a2c1d75 100644 --- a/packages/js/docs/ts/interfaces/INotification.md +++ b/packages/js/docs/ts/interfaces/INotification.md @@ -1,5 +1,3 @@ -# Interface: INotification - An event dispatched by Telnyx to notify the client of changes to the session or call. The conditions of the event can be identified by the `type` property. @@ -62,9 +60,9 @@ Notification ### Properties -- [call](INotification.md#call) -- [error](INotification.md#error) -- [type](INotification.md#type) +- [call](./interfaces/INotification.md#call) +- [error](./interfaces/INotification.md#error) +- [type](./interfaces/INotification.md#type) ## Properties diff --git a/packages/js/typedoc.json b/packages/js/typedoc.json index b6b2368d..0f176941 100644 --- a/packages/js/typedoc.json +++ b/packages/js/typedoc.json @@ -13,11 +13,14 @@ "excludePrivate": true, "excludeProtected": true, "excludeNotDocumented": true, + "cleanOutputDir": true, "excludeTags": ["@internalnote", "@internal"], "hideGenerator": true, "readme": "none", "gitRevision": "main", "disableSources": true, "hideBreadcrumbs": true, - "namedAnchors": true + "namedAnchors": true, + "hidePageTitle": true, + "publicPath": "./" }