import { IHttpClient } from "./IHttpClient"; import { IShortUserDescription } from "./IUser"; /** * The base class provides information about the file/assembly clash detection test and test results. */ export declare class ClashTest { private _data; private basePath; private httpClient; /** * @param data - Raw test data. * @param basePath - Clash tests API base path for the owner file/assembly. * @param httpClient - Http client. */ constructor(data: any, basePath: string, httpClient: IHttpClient); protected internalGet(relativePath: string): Promise; protected internalPut(relativePath: string, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise; protected internalDelete(relativePath: string): Promise; /** * The type of the clashes that the test detects: * * - `Сlearance clash` (true) - a clash in which the entity A may or may not intersect with * entity B, but comes within a distance of less than the `tolerance`. * - `Hard clash` (false) - a clash in which the entity A intersects with entity B by a * distance of more than the `tolerance`. * * @readonly */ get clearance(): boolean; /** * Test creation time (UTC) in the format specified in ISO 8601. * * @readonly */ get createdAt(): string; /** * Raw test data received from the server. * * @readonly */ get data(): any; private set data(value); /** * Unique test ID. * * @readonly */ get id(): string; /** * Test last update (UTC) time in the format specified in ISO 8601. * * @readonly */ get lastModifiedAt(): string; /** * Test name. */ get name(): string; set name(value: string); /** * Test owner information. * * @property {string} userId - User ID. * @property {string} userName - User name. * @property {string} name - First name. * @property {string} lastName - Last name. * @property {string} fullName - Full name. * @property {string} initials - Initials. * @property {string} email - User email. * @property {string} avatarUrl - User avatar image URL. * @readonly */ get owner(): IShortUserDescription; /** * First selection set for clash detection. Entities from `selectionSetA` will be tested * against each others by entities from the `selectionSetB` during the test. * * @readonly */ get selectionSetA(): string[]; /** * The type of first selection set for clash detection. Can be one of: * * - `all` - All file/assembly entities. * - `handle` - Entities with handles specified in the `selectionSetA`. * - `models` - Entities of file/assembly models specified in `selectionSetA`. * - `searchquery` - Entities retrieved by the search queries specified in `selectionSetA`. * * @readonly */ get selectionTypeA(): string; /** * Second selection set for clash detection. Entities from `selectionSetB` will be tested * against each others by entities from the `selectionSetA` during the test. * * @readonly */ get selectionSetB(): string[]; /** * The type of second selection set for clash detection. Can be one of: * * - `all` - All file/assembly entities. * - `handle` - Entities with handles specified in the `selectionSetB`. * - `models` - Entities of file/assembly models specified in `selectionSetB`. * - `searchquery` - Entities retrieved by the search queries specified in `selectionSetB`. * * @readonly */ get selectionTypeB(): string; /** * Test status. Can be `none`, `waiting`, `inprogress`, `done` or `failed`. * * @readonly */ get status(): string; /** * The distance of separation between entities at which test begins detecting clashes. * * @readonly */ get tolerance(): number; /** * Refresh test data. * * @async */ checkout(): Promise; /** * Update test data on the server. * * @async * @param data - Raw test data. */ update(data: any): Promise; /** * Remove a test from a file. * * @async * @returns Returns the raw data of a deleted test. */ delete(): Promise; /** * Save test data changes to the server. Call this method to update test data on the server * after any changes. * * @async */ save(): Promise; /** * Wait for test to complete. Test is done when it changes to `done` or `failed` status. * * @async * @param params - An object containing waiting parameters. * @param params.timeout - The time, in milliseconds that the function should wait test. If * test is not complete during this time, the `TimeoutError` exception will be thrown. * @param params.interval - The time, in milliseconds, the function should delay in between * checking test status. * @param params.signal- An AbortController * signal object instance, which can be used to abort waiting as desired. */ waitForDone(params?: { timeout?: number; interval?: number; signal?: AbortSignal; }): Promise; /** * Returns a report with the clash detection results for this test. * * @async */ getReport(): Promise; } //# sourceMappingURL=ClashTest.d.ts.map