import FrameManager from 'chrome-remote-interface-extra/lib/frames/FrameManager.js'

public class | source

FrameManager

Extends:

eventemitter3~EventEmitter → FrameManager

Constructor Summary

Public Constructor
public	constructor(client: Chrome \| CRIConnection \| CDPSession \| Object, frameTree: Object, timeoutSettings: TimeoutSettings, networkManager: NetworkManager, page: Page)

Member Summary

Private Members
private	_client: Chrome \| CRIConnection \| CDPSession \| Object
private	_contextIdToContext: Map<number, ExecutionContext>
private	_frames: Map<string, Frame>
private	_isolatedWorlds: Set<string>
private	_mainFrame: Frame
private	_networkManager: NetworkManager
private	_page: Page
private	_timeoutSettings: TimeoutSettings

Method Summary

Public Methods
public	async ensureSecondaryDOMWorld()
public	executionContextById(contextId: number): ExecutionContext	since chrome-remote-interface-extra
public	frame(frameId: string): Frame
public	frames(): Array<Frame>
public	async getFrameResourceContent(frameId: string, url: string): Promise<Buffer> Returns content of the given resource.	since chrome-remote-interface-extra
public	async getResourceTree(): Promise<FrameResourceTree>	since chrome-remote-interface-extra
public	mainFrame(): Frame
public	async navigateFrame(frame: Frame, url: string, options: {referer?: string, timeout?: number, waitUntil?: string\|Array<string>, transitionType?: string}=): Promise<Response\|undefined>
public	page(): Page
public	toJSON(): {"mainFrame": , "frames": }
public	async waitForFrameNavigation(frame: Frame, options: {timeout?: number, waitUntil?: string\|Array<string>}=): Promise<Response\|undefined>

Private Methods
private	async _ensureIsolatedWorld(name: string)
private	_handleFrameTree(frameTree: Object, first: boolean)
private	async _navigate(navigationParams: {transitionType: ?string, frameId: string, url: string, referrer: ?string}, endnObj: {ensureNewDocumentNavigation: boolean}): Promise<Error\|undefined>	since chrome-remote-interface-extra
private	_onExecutionContextCreated(event: Object)
private	_onExecutionContextDestroyed(event: Object)
private	_onExecutionContextsCleared()
private	_onFrameAttached(event: Object)
private	_onFrameDetached(event: Object)
private	_onFrameNavigated(event: Object)
private	_onFrameNavigatedWithinDocument(event: Object)
private	_onFrameStoppedLoading(event: Object)
private	_onLifecycleEvent(event: Object)
private	_removeFramesRecursively(frame: Frame)

Public Constructors

public constructor(client: Chrome | CRIConnection | CDPSession | Object, frameTree: Object, timeoutSettings: TimeoutSettings, networkManager: NetworkManager, page: Page) source

Params:

Name	Type	Attribute	Description
client	Chrome \| CRIConnection \| CDPSession \| Object
frameTree	Object	nullable: false
timeoutSettings	TimeoutSettings	nullable: false
networkManager	NetworkManager	optional
page	Page	optional

Private Members

private _client: Chrome | CRIConnection | CDPSession | Object source

private _contextIdToContext: Map<number, ExecutionContext> source

private _frames: Map<string, Frame> source

private _isolatedWorlds: Set<string> source

private _mainFrame: Frame source

private _networkManager: NetworkManager source

private _page: Page source

private _timeoutSettings: TimeoutSettings source

Public Methods

public async ensureSecondaryDOMWorld() source

public executionContextById(contextId: number): ExecutionContext since chrome-remote-interface-extra source

Params:

Name	Type	Attribute	Description
contextId	number

Return:

ExecutionContext (nullable: false)

public frame(frameId: string): Frame source

Params:

Name	Type	Attribute	Description
frameId	string	nullable: false

Return:

Frame (nullable: true)

public frames(): Array<Frame> source

Return:

Array<Frame> (nullable: false)

public async getFrameResourceContent(frameId: string, url: string): Promise<Buffer> since chrome-remote-interface-extra source

Returns content of the given resource. EXPERIMENTAL

Params:

Name	Type	Attribute	Description
frameId	string		Frame id to get resource for
url	string		URL of the resource to get content for

Return:

Promise<Buffer>

Resource content

See:

https://chromedevtools.github.io/devtools-protocol/tot/Page#method-getResourceContent

public async getResourceTree(): Promise<FrameResourceTree> since chrome-remote-interface-extra source

Return:

Promise<FrameResourceTree>

public mainFrame(): Frame source

Return:

Frame (nullable: false)

public async navigateFrame(frame: Frame, url: string, options: {referer?: string, timeout?: number, waitUntil?: string|Array<string>, transitionType?: string}=): Promise<Response|undefined> source

Params:

Name	Type	Attribute	Description
frame	Frame	nullable: false
url	string
options	{referer?: string, timeout?: number, waitUntil?: string\|Array<string>, transitionType?: string}=	nullable: false

Return:

Promise<Response|undefined>

public page(): Page source

Return:

Page (nullable: true)

public toJSON(): {"mainFrame": , "frames": } source

Return:

{"mainFrame": *, "frames": *}

public async waitForFrameNavigation(frame: Frame, options: {timeout?: number, waitUntil?: string|Array<string>}=): Promise<Response|undefined> source

Params:

Name	Type	Attribute	Description
frame	Frame	nullable: false
options	{timeout?: number, waitUntil?: string\|Array<string>}=	nullable: false

Return:

Promise<Response|undefined>

Private Methods

private async _ensureIsolatedWorld(name: string) source

Params:

Name	Type	Attribute	Description
name	string

private _handleFrameTree(frameTree: Object, first: boolean) source

Params:

Name	Type	Attribute	Description
frameTree	Object	nullable: false
first	boolean	optional default: false

private async _navigate(navigationParams: {transitionType: ?string, frameId: string, url: string, referrer: ?string}, endnObj: {ensureNewDocumentNavigation: boolean}): Promise<Error|undefined> since chrome-remote-interface-extra source

Params:

Name	Type	Attribute	Description
navigationParams	{transitionType: ?string, frameId: string, url: string, referrer: ?string}
endnObj	{ensureNewDocumentNavigation: boolean}

Return:

Promise<Error|undefined>

private _onExecutionContextCreated(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onExecutionContextDestroyed(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onExecutionContextsCleared() source

private _onFrameAttached(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onFrameDetached(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onFrameNavigated(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onFrameNavigatedWithinDocument(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onFrameStoppedLoading(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _onLifecycleEvent(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object	nullable: false

private _removeFramesRecursively(frame: Frame) source

Params:

Name	Type	Attribute	Description
frame	Frame	nullable: false

FrameManager

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(client: Chrome | CRIConnection | CDPSession | Object, frameTree: Object, timeoutSettings: TimeoutSettings, networkManager: NetworkManager, page: Page) source

Params:

Private Members

private _client: Chrome | CRIConnection | CDPSession | Object source

private _contextIdToContext: Map<number, ExecutionContext> source

private _frames: Map<string, Frame> source

private _isolatedWorlds: Set<string> source

private _mainFrame: Frame source

private _networkManager: NetworkManager source

private _page: Page source

private _timeoutSettings: TimeoutSettings source

Public Methods

public async ensureSecondaryDOMWorld() source

public executionContextById(contextId: number): ExecutionContext since chrome-remote-interface-extra source

Params:

Return:

public frame(frameId: string): Frame source

Params:

Return:

public frames(): Array<Frame> source

Return:

public async getFrameResourceContent(frameId: string, url: string): Promise<Buffer> since chrome-remote-interface-extra source

Params:

Return:

See:

public async getResourceTree(): Promise<FrameResourceTree> since chrome-remote-interface-extra source

Return:

public mainFrame(): Frame source

Return:

public async navigateFrame(frame: Frame, url: string, options: {referer?: string, timeout?: number, waitUntil?: string|Array<string>, transitionType?: string}=): Promise<Response|undefined> source

Params:

Return:

public page(): Page source

Return:

public toJSON(): {"mainFrame": *, "frames": *} source

Return:

public async waitForFrameNavigation(frame: Frame, options: {timeout?: number, waitUntil?: string|Array<string>}=): Promise<Response|undefined> source

Params:

Return:

Private Methods

private async _ensureIsolatedWorld(name: string) source

Params:

private _handleFrameTree(frameTree: Object, first: boolean) source

Params:

private async _navigate(navigationParams: {transitionType: ?string, frameId: string, url: string, referrer: ?string}, endnObj: {ensureNewDocumentNavigation: boolean}): Promise<Error|undefined> since chrome-remote-interface-extra source

Params:

Return:

private _onExecutionContextCreated(event: Object) source

Params:

private _onExecutionContextDestroyed(event: Object) source

Params:

private _onExecutionContextsCleared() source

private _onFrameAttached(event: Object) source

Params:

private _onFrameDetached(event: Object) source

Params:

private _onFrameNavigated(event: Object) source

Params:

private _onFrameNavigatedWithinDocument(event: Object) source

Params:

private _onFrameStoppedLoading(event: Object) source

Params:

private _onLifecycleEvent(event: Object) source

Params:

private _removeFramesRecursively(frame: Frame) source

Params:

public toJSON(): {"mainFrame": , "frames": } source