Skip to content

Commit 201da94

Browse files
author
John Riordan
committed
New API - udpate docs
1 parent 1d1fe81 commit 201da94

File tree

3 files changed

+14
-27
lines changed

3 files changed

+14
-27
lines changed

docs/api/sip.js.invitation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare class Invitation extends Session
1616
1717
| Property | Modifiers | Type | Description |
1818
| --- | --- | --- | --- |
19-
| [request](./sip.js.invitation.request.md) | | <code>IncomingRequestMessage</code> | Incoming MESSAGE request message. |
19+
| [request](./sip.js.invitation.request.md) | | <code>IncomingRequestMessage</code> | Incoming INVITE request message. |
2020
2121
## Methods
2222

docs/api/sip.js.invitation.request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Invitation.request property
66

7-
Incoming MESSAGE request message.
7+
Incoming INVITE request message.
88

99
<b>Signature:</b>
1010

etc/api/sip.js.api.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,6 @@ export class Invitation extends Session {
9898
//
9999
// @internal
100100
protected terminated(message?: IncomingResponseMessage | IncomingRequestMessage, cause?: string): void;
101-
// Warning: (ae-forgotten-export) The symbol "InviteServerTransaction" needs to be exported by the entry point index.d.ts
102-
// Warning: (ae-forgotten-export) The symbol "NonInviteServerTransaction" needs to be exported by the entry point index.d.ts
103-
//
104-
// @internal (undocumented)
105-
transaction: InviteServerTransaction | NonInviteServerTransaction;
106101
}
107102

108103
// @public
@@ -439,39 +434,35 @@ export abstract class Session extends EventEmitter {
439434
// @internal (undocumented)
440435
protected earlySdp: string | undefined;
441436
// @internal @deprecated (undocumented)
442-
emit(event: "renegotiationError", error: Error): boolean;
443-
// @internal @deprecated (undocumented)
444-
emit(event: "reinvite", session: Session, request: IncomingRequestMessage): boolean;
437+
emit(event: "confirmed" | "notify", request: IncomingRequestMessage): boolean;
445438
// @internal @deprecated (undocumented)
446-
emit(event: "referInviteSent" | "referRejected" | "referRequestProgress" | "referRequestAccepted" | "referRequestRejected" | "reinviteAccepted" | "reinviteFailed", session: Session): boolean;
439+
emit(event: "invite" | "refer" | "notify", request: OutgoingRequestMessage): boolean;
447440
// @internal @deprecated (undocumented)
448441
emit(event: "SessionDescriptionHandler-created", sessionDescriptionHandler: SessionDescriptionHandler): boolean;
449442
// @internal @deprecated (undocumented)
450-
emit(event: "confirmed" | "notify", request: IncomingRequestMessage): boolean;
443+
emit(event: "rejected", response?: IncomingRequestMessage | IncomingResponseMessage | string, cause?: string): boolean;
451444
// @internal @deprecated (undocumented)
452-
emit(event: "invite" | "refer" | "notify", request: OutgoingRequestMessage): boolean;
445+
emit(event: "reinvite", session: Session, request: IncomingRequestMessage): boolean;
453446
// @internal @deprecated (undocumented)
454447
emit(event: "bye", request: IncomingRequestMessage | OutgoingRequestMessage): boolean;
455448
// @internal @deprecated (undocumented)
449+
emit(event: "referInviteSent" | "referRejected" | "referRequestProgress" | "referRequestAccepted" | "referRequestRejected" | "reinviteAccepted" | "reinviteFailed", session: Session): boolean;
450+
// @internal @deprecated (undocumented)
451+
emit(event: "terminated", response?: IncomingRequestMessage | IncomingResponseMessage, cause?: string): boolean;
452+
// @internal @deprecated (undocumented)
456453
emit(event: "connecting", request: {
457454
request: IncomingRequestMessage;
458455
}): boolean;
459456
// @internal @deprecated (undocumented)
460457
emit(event: "progress", response: IncomingResponseMessage | string, reasonPhrase?: any): boolean;
461458
// @internal @deprecated (undocumented)
462-
emit(event: "failed" | "rejected", response?: IncomingRequestMessage | IncomingResponseMessage | string, cause?: string): boolean;
463-
// @internal @deprecated (undocumented)
464-
emit(event: "terminated", response?: IncomingRequestMessage | IncomingResponseMessage, cause?: string): boolean;
459+
emit(event: "renegotiationError", error: Error): boolean;
465460
// @internal @deprecated (undocumented)
466461
emit(event: "trackAdded" | "directionChanged" | "referRejected"): boolean;
467462
// @internal (undocumented)
468463
endTime: Date | undefined;
469464
// @internal (undocumented)
470-
protected errorListener: ((...args: Array<any>) => void);
471-
// @internal (undocumented)
472465
protected expiresTimer: any;
473-
// @internal @deprecated (undocumented)
474-
protected failed(response: IncomingResponseMessage | IncomingRequestMessage | undefined, cause: string): void;
475466
// @internal (undocumented)
476467
protected fromTag: string | undefined;
477468
// Warning: (ae-forgotten-export) The symbol "Body" needs to be exported by the entry point index.d.ts
@@ -509,6 +500,8 @@ export abstract class Session extends EventEmitter {
509500
// @internal (undocumented)
510501
method: string;
511502
// @internal @deprecated (undocumented)
503+
on(event: "reinvite", listener: (session: Session, request: IncomingRequestMessage) => void): this;
504+
// @internal @deprecated (undocumented)
512505
on(event: "confirmed" | "notify", listener: (request: IncomingRequestMessage) => void): this;
513506
// @internal @deprecated (undocumented)
514507
on(event: "bye", listener: (request: IncomingRequestMessage | OutgoingRequestMessage) => void): this;
@@ -519,7 +512,7 @@ export abstract class Session extends EventEmitter {
519512
// @internal @deprecated (undocumented)
520513
on(event: "progress", listener: (response: IncomingResponseMessage | string, reasonPhrase?: any) => void): this;
521514
// @internal @deprecated (undocumented)
522-
on(event: "failed" | "rejected", listener: (response?: IncomingRequestMessage | IncomingResponseMessage | string, cause?: string) => void): this;
515+
on(event: "rejected", listener: (response?: IncomingRequestMessage | IncomingResponseMessage | string, cause?: string) => void): this;
523516
// @internal @deprecated (undocumented)
524517
on(event: "terminated", listener: (response?: IncomingRequestMessage | IncomingResponseMessage, cause?: string) => void): this;
525518
// @internal @deprecated (undocumented)
@@ -530,8 +523,6 @@ export abstract class Session extends EventEmitter {
530523
on(event: "SessionDescriptionHandler-created", listener: (sessionDescriptionHandler: SessionDescriptionHandler) => void): this;
531524
// @internal @deprecated (undocumented)
532525
on(event: "referInviteSent" | "referProgress" | "referAccepted" | "referRequestProgress" | "referRequestAccepted" | "referRequestRejected" | "reinviteAccepted" | "reinviteFailed", listener: (session: Session) => void): this;
533-
// @internal @deprecated (undocumented)
534-
on(event: "reinvite", listener: (session: Session, request: IncomingRequestMessage) => void): this;
535526
// Warning: (ae-forgotten-export) The symbol "IncomingAckRequest" needs to be exported by the entry point index.d.ts
536527
//
537528
// @internal
@@ -555,10 +546,6 @@ export abstract class Session extends EventEmitter {
555546
// @internal
556547
protected onReferRequest(request: IncomingReferRequest): void;
557548
// @internal (undocumented)
558-
onRequestTimeout(): void;
559-
// @internal (undocumented)
560-
onTransportError(): void;
561-
// @internal (undocumented)
562549
protected passedOptions: any;
563550
// @internal
564551
refer(referrer: Referrer, delegate?: OutgoingRequestDelegate, options?: RequestOptions): Promise<OutgoingByeRequest>;

0 commit comments

Comments
 (0)