opentok-network-test-js
Version:
Precall network test for applications using the OpenTok platform.
19 lines • 751 B
TypeScript
/**
* @module Test/Connectivity
* @preferred
*
* Defines the methods required for the Connectivity Test Flow
*/
import OTKLogger from '@opentok/opentok-solutions-logging';
import { NetworkTestOptions } from '../index';
import { FailureCase } from './errors/mapping';
import { SessionCredentials } from '../types/session';
export type ConnectivityTestResults = {
success: boolean;
failedTests: FailureCase[];
};
/**
* This method checks to see if the client can connect to TokBox servers required for using OpenTok
*/
export declare function testConnectivity(OTInstance: typeof OT, credentials: SessionCredentials, otLogging: OTKLogger, options?: NetworkTestOptions): Promise<ConnectivityTestResults>;
//# sourceMappingURL=index.d.ts.map