theluyuan
38ba663466
Some checks failed
Close stale issues and PRs / stale (push) Has been cancelled
124 lines
3.5 KiB
TypeScript
124 lines
3.5 KiB
TypeScript
import { IConfig } from '../../react/features/base/config/configType';
|
|
|
|
import type { Participant } from './Participant';
|
|
import { ITestProperties } from './TestProperties';
|
|
import type WebhookProxy from './WebhookProxy';
|
|
import { IToken, ITokenOptions } from './token';
|
|
|
|
export type IContext = {
|
|
/**
|
|
* The up-to-four browser instances provided by the framework. These can be initialized using
|
|
* ensureOneParticipant, ensureTwoParticipants, etc. from participants.ts.
|
|
**/
|
|
p1: Participant;
|
|
p2: Participant;
|
|
p3: Participant;
|
|
p4: Participant;
|
|
/** A room name automatically generated by the framework for convenience. */
|
|
roomName: string;
|
|
/**
|
|
* A flag that tests can set, which signals to the framework that the (rest of the) test suite should be skipped.
|
|
*/
|
|
skipSuiteTests: boolean;
|
|
/**
|
|
* Test properties provided by the test file via TestProperties.setTestProperties. Used by the framework to
|
|
* set up the context appropriately.
|
|
**/
|
|
testProperties: ITestProperties;
|
|
times: any;
|
|
/**
|
|
* A WebhooksProxy instance generated by the framework and available for tests to use, if configured.
|
|
* Note that this is only configured for roomName, if a test wishes to use a different room name it can set up
|
|
* a WebhooksProxy instance itself.
|
|
*/
|
|
webhooksProxy: WebhookProxy;
|
|
};
|
|
|
|
export type IParticipantOptions = {
|
|
/** Whether it should use the iFrame API. */
|
|
iFrameApi?: boolean;
|
|
/** Must be 'p1', 'p2', 'p3', or 'p4'. */
|
|
name: string;
|
|
/** An optional token to use. */
|
|
token?: IToken;
|
|
};
|
|
|
|
/**
|
|
* Options for joinConference.
|
|
*/
|
|
export type IParticipantJoinOptions = {
|
|
|
|
/**
|
|
* Config overwrites to use.
|
|
*/
|
|
configOverwrite?: IConfig;
|
|
|
|
/**
|
|
* An optional tenant to use. If provided the URL is prepended with /$forceTenant
|
|
*/
|
|
forceTenant?: string;
|
|
|
|
/** The name of the room to join */
|
|
roomName: string;
|
|
|
|
/**
|
|
* Whether to skip setting display name.
|
|
*/
|
|
skipDisplayName?: boolean;
|
|
|
|
/**
|
|
* Whether to skip waiting for the participant to join the room. Cases like lobby where we do not succeed to join
|
|
* based on the logic of the test.
|
|
*/
|
|
skipWaitToJoin?: boolean;
|
|
};
|
|
|
|
export type IJoinOptions = {
|
|
|
|
/**
|
|
* Config overwrites to pass to IParticipantJoinOptions.
|
|
*/
|
|
configOverwrite?: IConfig;
|
|
|
|
/**
|
|
* An optional tenant to use. If provided the URL is prepended with /$forceTenant
|
|
*/
|
|
forceTenant?: string;
|
|
|
|
/**
|
|
* When joining the first participant and jwt singing material is available and a provided token
|
|
* is available, prefer generating a new token for the first participant.
|
|
*/
|
|
preferGenerateToken?: boolean;
|
|
|
|
/**
|
|
* To be able to override the ctx generated room name. If missing the one from the context will be used.
|
|
*/
|
|
roomName?: string;
|
|
|
|
/**
|
|
*The skip display name setting to pass to IParticipantJoinOptions.
|
|
*/
|
|
skipDisplayName?: boolean;
|
|
|
|
/**
|
|
* Whether to skip setting the moderator role for the first participant (whether to use jwt for it).
|
|
*/
|
|
skipFirstModerator?: boolean;
|
|
|
|
/**
|
|
* Whether to skip in meeting checks like ice connected and send receive data. For single in meeting participant.
|
|
*/
|
|
skipInMeetingChecks?: boolean;
|
|
|
|
/**
|
|
* The skip waiting for the participant to join the room setting to pass to IParticipantJoinOptions.
|
|
*/
|
|
skipWaitToJoin?: boolean;
|
|
|
|
/**
|
|
* Options used when generating a token.
|
|
*/
|
|
tokenOptions?: ITokenOptions;
|
|
};
|