Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(WEBRTC-478): hide telnyxIDs and clientState on public docs #172

Merged
merged 3 commits into from
Apr 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ node_modules
yarn-error.log
lib
coverage
.vscode
.vscode
yarn.lock
18 changes: 0 additions & 18 deletions packages/js/docs/ts/classes/call.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ call.muteAudio();

- [localStream](call.md#localstream)
- [remoteStream](call.md#remotestream)
- [telnyxIDs](call.md#telnyxids)

### Methods

Expand Down Expand Up @@ -192,23 +191,6 @@ document.querySelector('audio').srcObject = stream;

**Returns:** MediaStream

___

### telnyxIDs

β€’ get **telnyxIDs**(): *object*

Gets Telnyx call IDs, if using Telnyx Call Control services.
You can use these IDs to identify specific calls in your application code.

**`examples`**

```js
const { telnyxCallControlId, telnyxSessionId, telnyxLegId } = call.telnyxIDs;
```

**Returns:** *object*

## Methods

### answer
Expand Down
10 changes: 0 additions & 10 deletions packages/js/docs/ts/interfaces/icalloptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ ICallOptions
- [callerName](icalloptions.md#callername)
- [callerNumber](icalloptions.md#callernumber)
- [camId](icalloptions.md#camid)
- [clientState](icalloptions.md#clientstate)
- [destinationNumber](icalloptions.md#destinationnumber)
- [iceServers](icalloptions.md#iceservers)
- [id](icalloptions.md#id)
Expand Down Expand Up @@ -63,15 +62,6 @@ ___

___

### clientState

β€’ `Optional` **clientState**: *string*

Telnyx's Call Control client_state. Can be used with Connections with Advanced -> Events enabled.
`clientState` string should be base64 encoded.

___

### destinationNumber

β€’ **destinationNumber**: *string*
Expand Down
2 changes: 2 additions & 0 deletions packages/js/src/Modules/Verto/webrtc/BaseCall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ export default abstract class BaseCall implements IWebRTCCall {
}

/**
* @hidden
*
* Gets Telnyx call IDs, if using Telnyx Call Control services.
* You can use these IDs to identify specific calls in your application code.
*
Expand Down
2 changes: 2 additions & 0 deletions packages/js/src/utils/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ export interface ICallOptions {
*/
telnyxLegId?: string;
/**
* @hidden
*
* Telnyx's Call Control client_state. Can be used with Connections with Advanced -> Events enabled.
* `clientState` string should be base64 encoded.
*/
Expand Down
Loading