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.

Sign up for GitHub

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

Update packages/js typedocs files #43

Merged
merged 1 commit into from
Sep 25, 2020
Merged

Update packages/js typedocs files #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Update typedocs files
  • Loading branch information
@hugooliveirad
hugooliveirad committed Sep 25, 2020
commit 667c38867cc83076c4c3c5075b99d4fbaa2fb4d9
621 changes: 611 additions & 10 deletions packages/js/docs/ts/README.md
View file
Open in desktop

Large diffs are not rendered by default.

123 changes: 75 additions & 48 deletions packages/js/docs/ts/classes/basecall.md
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions packages/js/docs/ts/classes/baseclient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[@telnyx/webrtc - v2.1.0](../README.md) › [BaseClient](baseclient.md)
[@telnyx/webrtc - v2.1.5](../README.md) › [BaseClient](baseclient.md)

# Class: BaseClient

Expand Down Expand Up @@ -44,7 +44,7 @@

\+ **new BaseClient**(`o?`: [IClientOptions](../interfaces/iclientoptions.md)): *[BaseClient](baseclient.md)*

*Defined in [src/BaseClient.ts:49](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L49)*
*Defined in [packages/js/src/BaseClient.ts:49](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L49)*

**Parameters:**

Expand All @@ -60,101 +60,101 @@ Name | Type |

• **credentials**: *[ICredentials](../interfaces/icredentials.md)*

*Defined in [src/BaseClient.ts:36](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L36)*
*Defined in [packages/js/src/BaseClient.ts:36](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L36)*

___

### displayName

• **displayName**: *string*

*Defined in [src/BaseClient.ts:40](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L40)*
*Defined in [packages/js/src/BaseClient.ts:40](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L40)*

___

### env

• **env**: *[Env](../README.md#env)*

*Defined in [src/BaseClient.ts:33](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L33)*
*Defined in [packages/js/src/BaseClient.ts:33](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L33)*

___

### host

• **host**: *string*

*Defined in [src/BaseClient.ts:31](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L31)*
*Defined in [packages/js/src/BaseClient.ts:31](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L31)*

___

### module

• **module**: *[Module](../README.md#module)*

*Defined in [src/BaseClient.ts:34](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L34)*
*Defined in [packages/js/src/BaseClient.ts:34](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L34)*

___

### port

• **port**: *number*

*Defined in [src/BaseClient.ts:32](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L32)*
*Defined in [packages/js/src/BaseClient.ts:32](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L32)*

___

### `Optional` project

• **project**? : *string*

*Defined in [src/BaseClient.ts:35](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L35)*
*Defined in [packages/js/src/BaseClient.ts:35](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L35)*

___

### `Optional` ringFile

• **ringFile**? : *string*

*Defined in [src/BaseClient.ts:41](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L41)*
*Defined in [packages/js/src/BaseClient.ts:41](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L41)*

___

### useCamera

• **useCamera**: *string | boolean*

*Defined in [src/BaseClient.ts:39](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L39)*
*Defined in [packages/js/src/BaseClient.ts:39](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L39)*

___

### useMic

• **useMic**: *string | boolean*

*Defined in [src/BaseClient.ts:37](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L37)*
*Defined in [packages/js/src/BaseClient.ts:37](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L37)*

___

### useSpeaker

• **useSpeaker**: *string | boolean*

*Defined in [src/BaseClient.ts:38](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L38)*
*Defined in [packages/js/src/BaseClient.ts:38](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L38)*

## Accessors

### localElement

• **get localElement**(): *string | Function | HTMLMediaElement*

*Defined in [src/BaseClient.ts:65](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L65)*
*Defined in [packages/js/src/BaseClient.ts:65](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L65)*

**Returns:** *string | Function | HTMLMediaElement*

• **set localElement**(`el`: [RTCElement](../README.md#rtcelement)): *void*

*Defined in [src/BaseClient.ts:61](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L61)*
*Defined in [packages/js/src/BaseClient.ts:61](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L61)*

**Parameters:**

Expand All @@ -170,13 +170,13 @@ ___

• **get remoteElement**(): *string | Function | HTMLMediaElement*

*Defined in [src/BaseClient.ts:73](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L73)*
*Defined in [packages/js/src/BaseClient.ts:73](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L73)*

**Returns:** *string | Function | HTMLMediaElement*

• **set remoteElement**(`el`: [RTCElement](../README.md#rtcelement)): *void*

*Defined in [src/BaseClient.ts:69](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L69)*
*Defined in [packages/js/src/BaseClient.ts:69](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L69)*

**Parameters:**

Expand All @@ -192,7 +192,7 @@ Name | Type |

▸ **connect**(): *void*

*Defined in [src/BaseClient.ts:85](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L85)*
*Defined in [packages/js/src/BaseClient.ts:85](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L85)*

**Returns:** *void*

Expand All @@ -202,7 +202,7 @@ ___

▸ **disconnect**(): *void*

*Defined in [src/BaseClient.ts:86](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L86)*
*Defined in [packages/js/src/BaseClient.ts:86](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L86)*

**Returns:** *void*

Expand All @@ -212,7 +212,7 @@ ___

▸ **newCall**(`options`: [ICallOptions](../interfaces/icalloptions.md)): *[ICall](../interfaces/icall.md)*

*Defined in [src/BaseClient.ts:95](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L95)*
*Defined in [packages/js/src/BaseClient.ts:95](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L95)*

**Parameters:**

Expand All @@ -228,7 +228,7 @@ ___

▸ **on**‹**E**›(`message`: E, `cb`: MessageEvents[E]): *[BaseClient](baseclient.md)*

*Defined in [src/BaseClient.ts:77](https://github.com/team-telnyx/webrtc/blob/649bf48/src/BaseClient.ts#L77)*
*Defined in [packages/js/src/BaseClient.ts:77](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/BaseClient.ts#L77)*

**Type parameters:**

Expand Down
89 changes: 89 additions & 0 deletions packages/js/docs/ts/classes/baserequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
[@telnyx/webrtc - v2.1.5](../README.md) › [BaseRequest](baserequest.md)

# Class: BaseRequest

## Hierarchy

* BaseMessage

↳ **BaseRequest**

## Index

### Constructors

* [constructor](baserequest.md#constructor)

### Properties

* [request](baserequest.md#request)
* [response](baserequest.md#response)
* [targetNodeId](baserequest.md#targetnodeid)

### Methods

* [buildRequest](baserequest.md#buildrequest)

## Constructors

### constructor

\+ **new BaseRequest**(`params`: any): *[BaseRequest](baserequest.md)*

*Defined in [packages/js/src/Modules/Verto/messages/verto/BaseRequest.ts:12](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/verto/BaseRequest.ts#L12)*

**Parameters:**

Name | Type | Default |
------ | ------ | ------ |
`params` | any | {} |

**Returns:** *[BaseRequest](baserequest.md)*

## Properties

### request

• **request**: *any*

*Inherited from void*

*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:5](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L5)*

___

### response

• **response**: *any*

*Inherited from void*

*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:6](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L6)*

___

### targetNodeId

• **targetNodeId**: *string*

*Inherited from void*

*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:7](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L7)*

## Methods

### buildRequest

▸ **buildRequest**(`params`: any): *void*

*Inherited from void*

*Defined in [packages/js/src/Modules/Verto/messages/BaseMessage.ts:9](https://github.com/team-telnyx/webrtc/blob/4f15142/packages/js/src/Modules/Verto/messages/BaseMessage.ts#L9)*

**Parameters:**

Name | Type |
------ | ------ |
`params` | any |

**Returns:** *void*
Loading