77 lines
4.1 KiB
TypeScript
77 lines
4.1 KiB
TypeScript
/**
|
|
* Copyright 2022 Google LLC.
|
|
* Copyright (c) Microsoft Corporation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
import type { Protocol } from 'devtools-protocol';
|
|
import { BrowsingContext, Session } from '../../../protocol/protocol.js';
|
|
import { type LoggerFn } from '../../../utils/log.js';
|
|
import type { CdpTarget } from '../cdp/CdpTarget.js';
|
|
import type { Realm } from '../script/Realm.js';
|
|
import type { RealmStorage } from '../script/RealmStorage.js';
|
|
import type { EventManager } from '../session/EventManager.js';
|
|
import type { BrowsingContextStorage } from './BrowsingContextStorage.js';
|
|
export declare class BrowsingContextImpl {
|
|
#private;
|
|
static readonly LOGGER_PREFIX: "debug:browsingContext";
|
|
readonly userContext: string;
|
|
private constructor();
|
|
static create(id: BrowsingContext.BrowsingContext, parentId: BrowsingContext.BrowsingContext | null, userContext: string, cdpTarget: CdpTarget, eventManager: EventManager, browsingContextStorage: BrowsingContextStorage, realmStorage: RealmStorage, url: string, originalOpener?: string, unhandledPromptBehavior?: Session.UserPromptHandler, logger?: LoggerFn): BrowsingContextImpl;
|
|
/**
|
|
* @see https://html.spec.whatwg.org/multipage/document-sequences.html#navigable
|
|
*/
|
|
get navigableId(): string | undefined;
|
|
get navigationId(): string;
|
|
dispose(emitContextDestroyed: boolean): void;
|
|
/** Returns the ID of this context. */
|
|
get id(): BrowsingContext.BrowsingContext;
|
|
/** Returns the parent context ID. */
|
|
get parentId(): BrowsingContext.BrowsingContext | null;
|
|
/** Sets the parent context ID and updates parent's children. */
|
|
set parentId(parentId: BrowsingContext.BrowsingContext | null);
|
|
/** Returns the parent context. */
|
|
get parent(): BrowsingContextImpl | null;
|
|
/** Returns all direct children contexts. */
|
|
get directChildren(): BrowsingContextImpl[];
|
|
/** Returns all children contexts, flattened. */
|
|
get allChildren(): BrowsingContextImpl[];
|
|
/**
|
|
* Returns true if this is a top-level context.
|
|
* This is the case whenever the parent context ID is null.
|
|
*/
|
|
isTopLevelContext(): boolean;
|
|
get top(): BrowsingContextImpl;
|
|
addChild(childId: BrowsingContext.BrowsingContext): void;
|
|
get cdpTarget(): CdpTarget;
|
|
updateCdpTarget(cdpTarget: CdpTarget): void;
|
|
get url(): string;
|
|
lifecycleLoaded(): Promise<void>;
|
|
targetUnblockedOrThrow(): Promise<void>;
|
|
getOrCreateSandbox(sandbox: string | undefined): Promise<Realm>;
|
|
serializeToBidiValue(maxDepth?: number, addParentField?: boolean): BrowsingContext.Info;
|
|
onTargetInfoChanged(params: Protocol.Target.TargetInfoChangedEvent): void;
|
|
navigate(url: string, wait: BrowsingContext.ReadinessState): Promise<BrowsingContext.NavigateResult>;
|
|
reload(ignoreCache: boolean, wait: BrowsingContext.ReadinessState): Promise<BrowsingContext.NavigateResult>;
|
|
setViewport(viewport?: BrowsingContext.Viewport | null, devicePixelRatio?: number | null): Promise<void>;
|
|
handleUserPrompt(accept?: boolean, userText?: string): Promise<void>;
|
|
activate(): Promise<void>;
|
|
captureScreenshot(params: BrowsingContext.CaptureScreenshotParameters): Promise<BrowsingContext.CaptureScreenshotResult>;
|
|
print(params: BrowsingContext.PrintParameters): Promise<BrowsingContext.PrintResult>;
|
|
close(): Promise<void>;
|
|
traverseHistory(delta: number): Promise<void>;
|
|
toggleModulesIfNeeded(): Promise<void>;
|
|
locateNodes(params: BrowsingContext.LocateNodesParameters): Promise<BrowsingContext.LocateNodesResult>;
|
|
}
|
|
export declare function serializeOrigin(origin: string): string;
|