Skip to content

Commit 8f7bcfe

Browse files
author
John Riordan
committed
Docs - update api docs
1 parent d6b08d7 commit 8f7bcfe

9 files changed

+69
-5
lines changed

docs/api/sip.js.inviteroptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Options for [Inviter](./sip.js.inviter.md) constructor.
99
<b>Signature:</b>
1010

1111
```typescript
12-
export interface InviterOptions
12+
export interface InviterOptions extends SessionOptions
1313
```
1414
1515
## Properties

docs/api/sip.js.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,11 @@ A simple yet powerful API which takes care of SIP signaling and WebRTC media ses
6767
| [SessionDescriptionHandlerModifier](./sip.js.sessiondescriptionhandlermodifier.md) | Modifier for [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) offer/answer. |
6868
| [SessionDescriptionHandlerOptions](./sip.js.sessiondescriptionhandleroptions.md) | Options for [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) methods. |
6969
| [SessionInviteOptions](./sip.js.sessioninviteoptions.md) | Options for [Session.invite()](./sip.js.session.invite.md)<!-- -->. |
70+
| [SessionOptions](./sip.js.sessionoptions.md) | Options for [Session](./sip.js.session.md) constructor. |
7071
| [SubscriberOptions](./sip.js.subscriberoptions.md) | Options for [Subscriber](./sip.js.subscriber.md) constructor. |
7172
| [SubscriberSubscribeOptions](./sip.js.subscribersubscribeoptions.md) | Options for [Subscriber.subscribe()](./sip.js.subscriber.subscribe.md)<!-- -->. |
7273
| [SubscriptionDelegate](./sip.js.subscriptiondelegate.md) | Delegate for [Subscription](./sip.js.subscription.md)<!-- -->. |
74+
| [SubscriptionOptions](./sip.js.subscriptionoptions.md) | Options for [Subscription](./sip.js.subscription.md) constructor. |
7375
| [SubscriptionSubscribeOptions](./sip.js.subscriptionsubscribeoptions.md) | Options for [Subscription.subscribe()](./sip.js.subscription.subscribe.md)<!-- -->. |
7476
| [SubscriptionUnsubscribeOptions](./sip.js.subscriptionunsubscribeoptions.md) | Options for [Subscription.unsubscribe()](./sip.js.subscription.unsubscribe.md)<!-- -->. |
7577
| [UserAgentDelegate](./sip.js.useragentdelegate.md) | Delegate for [UserAgent](./sip.js.useragent.md)<!-- -->. |
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SessionOptions](./sip.js.sessionoptions.md) &gt; [delegate](./sip.js.sessionoptions.delegate.md)
4+
5+
## SessionOptions.delegate property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
delegate?: SessionDelegate;
11+
```

docs/api/sip.js.sessionoptions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SessionOptions](./sip.js.sessionoptions.md)
4+
5+
## SessionOptions interface
6+
7+
Options for [Session](./sip.js.session.md) constructor.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface SessionOptions
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [delegate](./sip.js.sessionoptions.delegate.md) | <code>SessionDelegate</code> | |
20+

docs/api/sip.js.subscriberoptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Options for [Subscriber](./sip.js.subscriber.md) constructor.
99
<b>Signature:</b>
1010

1111
```typescript
12-
export interface SubscriberOptions
12+
export interface SubscriberOptions extends SubscriptionOptions
1313
```
1414
1515
## Properties
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SubscriptionOptions](./sip.js.subscriptionoptions.md) &gt; [delegate](./sip.js.subscriptionoptions.delegate.md)
4+
5+
## SubscriptionOptions.delegate property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
delegate?: SubscriptionDelegate;
11+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SubscriptionOptions](./sip.js.subscriptionoptions.md)
4+
5+
## SubscriptionOptions interface
6+
7+
Options for [Subscription](./sip.js.subscription.md) constructor.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface SubscriptionOptions
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [delegate](./sip.js.subscriptionoptions.delegate.md) | <code>SubscriptionDelegate</code> | |
20+

docs/api/sip.js.useragentoptions.log.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
```typescript
1010
log?: {
1111
builtinEnabled: boolean;
12-
level: string | number;
13-
connector: (level: string, category: string, label: string | undefined, content: any) => void;
12+
level?: string | number;
13+
connector?: (level: string, category: string, label: string | undefined, content: any) => void;
1414
};
1515
```

docs/api/sip.js.useragentoptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface UserAgentOptions
3333
| [hackViaTcp](./sip.js.useragentoptions.hackviatcp.md) | <code>boolean</code> | |
3434
| [hackWssInTransport](./sip.js.useragentoptions.hackwssintransport.md) | <code>boolean</code> | |
3535
| [hostportParams](./sip.js.useragentoptions.hostportparams.md) | <code>any</code> | |
36-
| [log](./sip.js.useragentoptions.log.md) | <code>{</code><br/><code> builtinEnabled: boolean;</code><br/><code> level: string &#124; number;</code><br/><code> connector: (level: string, category: string, label: string &#124; undefined, content: any) =&gt; void;</code><br/><code> }</code> | |
36+
| [log](./sip.js.useragentoptions.log.md) | <code>{</code><br/><code> builtinEnabled: boolean;</code><br/><code> level?: string &#124; number;</code><br/><code> connector?: (level: string, category: string, label: string &#124; undefined, content: any) =&gt; void;</code><br/><code> }</code> | |
3737
| [noAnswerTimeout](./sip.js.useragentoptions.noanswertimeout.md) | <code>number</code> | Time (in seconds) after which an incoming call is rejected if not answered. |
3838
| [password](./sip.js.useragentoptions.password.md) | <code>string</code> | |
3939
| [register](./sip.js.useragentoptions.register.md) | <code>boolean</code> | Indicate if the user agent should register automatically when starting. |

0 commit comments

Comments
 (0)