Skip to content

Commit

Permalink
chore: update doc generator links
Browse files Browse the repository at this point in the history
  • Loading branch information
farhat-ha committed Oct 9, 2024
1 parent 8ac1d8c commit 7563492
Show file tree
Hide file tree
Showing 7 changed files with 121 additions and 111 deletions.
12 changes: 5 additions & 7 deletions packages/js/docs/ts/README.md
Original file line number Diff line number Diff line change
@@ -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)
52 changes: 25 additions & 27 deletions packages/js/docs/ts/classes/Call.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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

Expand Down
91 changes: 54 additions & 37 deletions packages/js/docs/ts/classes/TelnyxRTC.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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`**
Expand Down Expand Up @@ -850,19 +849,19 @@ ___
### <a id="newcall" name="newcall"></a> newCall
▸ **newCall**(`options`): [`Call`](Call.md)
▸ **newCall**(`options`): [`Call`](./classes/Call.md)
Makes a new outbound call.
#### Parameters
| 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.
Expand Down Expand Up @@ -910,7 +909,7 @@ ___
### <a id="off" name="off"></a> 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.
Expand All @@ -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.
Expand Down Expand Up @@ -956,7 +955,7 @@ ___
### <a id="on" name="on"></a> on
▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](TelnyxRTC.md)
▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](./classes/TelnyxRTC.md)
Attaches an event handler for a specific type of event.
Expand All @@ -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.
Expand All @@ -1004,6 +1003,24 @@ TelnyxRTCClient.on
___
### <a id="onnetworkclose" name="onnetworkclose"></a> onNetworkClose
▸ **onNetworkClose**(): `void`
Callback when the ws connection is going to close or get an error
#### Returns
`void`
void
#### Inherited from
TelnyxRTCClient.onNetworkClose
___
### <a id="setaudiosettings" name="setaudiosettings"></a> setAudioSettings
▸ **setAudioSettings**(`settings`): `Promise`\<`MediaTrackConstraints`\>
Expand Down
52 changes: 25 additions & 27 deletions packages/js/docs/ts/interfaces/ICallOptions.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,35 @@
# Interface: ICallOptions

ICallOptions
ICallOptions

## Table of contents

### 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

Expand Down
12 changes: 5 additions & 7 deletions packages/js/docs/ts/interfaces/IClientOptions.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Interface: IClientOptions

IClientOptions
IClientOptions

## Table of contents

### 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

Expand Down
8 changes: 3 additions & 5 deletions packages/js/docs/ts/interfaces/INotification.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion packages/js/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "./"
}

0 comments on commit 7563492

Please sign in to comment.