ue-softphone-sdk 2.2.2 → 2.2.4

package/src/api/exceptions/index.ts

@@ -0,0 +1,5 @@
+export * from "./content-type-unsupported";
+export * from "./request-pending";
+export * from "./session-description-handler";
+export * from "./session-terminated";
+export * from "./state-transition";

package/src/api/exceptions/request-pending.ts

@@ -0,0 +1,12 @@
+import { Exception } from "../../core";
+
+/**
+ * An exception indicating an outstanding prior request prevented execution.
+ * @public
+ */
+export class RequestPendingError extends Exception {
+  /** @internal */
+  public constructor(message?: string) {
+    super(message ? message : "Request pending.");
+  }
+}

package/src/api/exceptions/session-description-handler.ts

@@ -0,0 +1,11 @@
+import { Exception } from "../../core";
+
+/**
+ * An exception indicating a session description handler error occured.
+ * @public
+ */
+export class SessionDescriptionHandlerError extends Exception {
+  public constructor(message?: string) {
+    super(message ? message : "Unspecified session description handler error.");
+  }
+}

package/src/api/exceptions/session-terminated.ts

@@ -0,0 +1,11 @@
+import { Exception } from "../../core";
+
+/**
+ * An exception indicating the session terminated before the action completed.
+ * @public
+ */
+export class SessionTerminatedError extends Exception {
+  public constructor() {
+    super("The session has terminated.");
+  }
+}

package/src/api/exceptions/state-transition.ts

@@ -0,0 +1,11 @@
+import { Exception } from "../../core";
+
+/**
+ * An exception indicating an invalid state transition error occured.
+ * @public
+ */
+export class StateTransitionError extends Exception {
+  public constructor(message?: string) {
+    super(message ? message : "An error occurred during state transition.");
+  }
+}

package/src/api/index.ts

@@ -0,0 +1,58 @@
+/**
+ * A simple yet powerful API which takes care of SIP signaling and WebRTC media sessions for you.
+ * @packageDocumentation
+ */
+export * from "./exceptions";
+export * from "./bye";
+export * from "./emitter";
+export * from "./info";
+export * from "./invitation-accept-options";
+export * from "./invitation-progress-options";
+export * from "./invitation-reject-options";
+export * from "./invitation";
+export * from "./inviter-cancel-options";
+export * from "./inviter-invite-options";
+export * from "./inviter-options";
+export * from "./inviter";
+export * from "./message";
+export * from "./messager-message-options";
+export * from "./messager-options";
+export * from "./messager";
+export * from "./notification";
+export * from "./publisher-options";
+export * from "./publisher-publish-options";
+export * from "./publisher-state";
+export * from "./publisher-unpublish-options";
+export * from "./publisher";
+export * from "./referral";
+export * from "./registerer-options";
+export * from "./registerer-register-options";
+export * from "./registerer-state";
+export * from "./registerer-unregister-options";
+export * from "./registerer";
+export * from "./session-bye-options";
+export * from "./session-delegate";
+export * from "./session-description-handler-factory";
+export * from "./session-description-handler";
+export * from "./session-info-options";
+export * from "./session-invite-options";
+export * from "./session-message-options";
+export * from "./session-options";
+export * from "./session-refer-options";
+export * from "./session-state";
+export * from "./session";
+export * from "./subscriber-options";
+export * from "./subscriber-subscribe-options";
+export * from "./subscriber";
+export * from "./subscription-delegate";
+export * from "./subscription-options";
+export * from "./subscription-state";
+export * from "./subscription-subscribe-options";
+export * from "./subscription-unsubscribe-options";
+export * from "./subscription";
+export * from "./transport";
+export * from "./transport-state";
+export * from "./user-agent-delegate";
+export * from "./user-agent-options";
+export * from "./user-agent-state";
+export * from "./user-agent";

package/src/api/info.ts

@@ -0,0 +1,27 @@
+import { IncomingInfoRequest, IncomingRequestMessage, ResponseOptions } from "../core";
+
+/**
+ * An exchange of information (incoming INFO).
+ * @public
+ */
+export class Info {
+  /** @internal */
+  public constructor(private incomingInfoRequest: IncomingInfoRequest) {}
+
+  /** Incoming MESSAGE request message. */
+  public get request(): IncomingRequestMessage {
+    return this.incomingInfoRequest.message;
+  }
+
+  /** Accept the request. */
+  public accept(options?: ResponseOptions): Promise<void> {
+    this.incomingInfoRequest.accept(options);
+    return Promise.resolve();
+  }
+
+  /** Reject the request. */
+  public reject(options?: ResponseOptions): Promise<void> {
+    this.incomingInfoRequest.reject(options);
+    return Promise.resolve();
+  }
+}

package/src/api/invitation-accept-options.ts

@@ -0,0 +1,20 @@
+import { SessionDescriptionHandlerModifier, SessionDescriptionHandlerOptions } from "./session-description-handler";
+
+/**
+ * Options for {@link Invitation.accept}.
+ * @public
+ */
+export interface InvitationAcceptOptions {
+  /**
+   * Array of extra headers added to the response.
+   */
+  extraHeaders?: Array<string>;
+  /**
+   * Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.
+   */
+  sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+  /**
+   * Options to pass to SessionDescriptionHandler during the initial INVITE transaction.
+   */
+  sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+}

package/src/api/invitation-progress-options.ts

@@ -0,0 +1,36 @@
+import { SessionDescriptionHandlerModifier, SessionDescriptionHandlerOptions } from "./session-description-handler";
+
+/**
+ * Options for {@link Invitation.progress}.
+ * @public
+ */
+export interface InvitationProgressOptions {
+  /**
+   * Body
+   */
+  body?: string | { body: string; contentType: string };
+  /**
+   * Array of extra headers added to the response.
+   */
+  extraHeaders?: Array<string>;
+  /**
+   * Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.
+   */
+  sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
+  /**
+   * Options to pass to SessionDescriptionHandler during the initial INVITE transaction.
+   */
+  sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
+  /**
+   * Status code for response.
+   */
+  statusCode?: number;
+  /**
+   * Reason phrase for response.
+   */
+  reasonPhrase?: string;
+  /**
+   * Send reliable response.
+   */
+  rel100?: boolean;
+}

package/src/api/invitation-reject-options.ts

@@ -0,0 +1,22 @@
+/**
+ * Options for {@link Invitation.reject}.
+ * @public
+ */
+export interface InvitationRejectOptions {
+  /**
+   * Body
+   */
+  body?: string | { body: string; contentType: string };
+  /**
+   * Array of extra headers added to the response.
+   */
+  extraHeaders?: Array<string>;
+  /**
+   * Status code for response.
+   */
+  statusCode?: number;
+  /**
+   * Reason phrase for response.
+   */
+  reasonPhrase?: string;
+}