opentok-network-test-js/src/NetworkTest/errors/index.ts

Precall network test for applications using the OpenTok platform.

/**
 * @module Errors
 */

import { ErrorNames } from './types';

/**
  * Base class for errors used throughout Network Connectivity tests.
  */
export class NetworkTestError extends Error {
  name: string;
  constructor(message: string, name?: string) {
    super(message);
    this.name = name || ErrorNames.NETWORK_TEST_ERROR;
    this.stack = (new Error(message)).stack;
  }
}

export class MissingOpenTokInstanceError extends NetworkTestError {
  constructor() {
    super('An instance of OT, the OpenTok.js client SDK, is required.');
    this.name = ErrorNames.MISSING_OPENTOK_INSTANCE;
  }
}

export class IncompleteSessionCredentialsError extends NetworkTestError {
  constructor() {
    super('NetworkConnectivity requires an apiKey, sessionId, and token.',
      ErrorNames.INCOMPLETE_SESSON_CREDENTIALS);
  }
}

export class MissingSessionCredentialsError extends NetworkTestError {
  constructor() {
    super('NetworkConnectivity requires OpenTok session credentials.',
      ErrorNames.MISSING_SESSON_CREDENTIALS);
  }
}

export class InvalidOnUpdateCallback extends NetworkTestError {
  constructor() {
    super('The onUpdate callback must be a function that accepts a single parameter.',
      ErrorNames.INVALID_ON_UPDATE_CALLBACK);
  }
}
export class PermissionDeniedError extends NetworkTestError {
  constructor() {
    super('Precall failed to acquire camera due to a permissions error.',
      ErrorNames.PERMISSION_DENIED_ERROR);
  }
}

export class UnsupportedResolutionError extends NetworkTestError {
  constructor() {
    super('The camera does not support the given resolution.',
      ErrorNames.UNSUPPORTED_RESOLUTION_ERROR);
  }
}