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

public class | source

Target

See:

https://chromedevtools.github.io/devtools-protocol/tot/Target

Constructor Summary

Public Constructor
public	constructor(targetInit: TargetInit)

Member Summary

Private Members
private	_browserContext: BrowserContext
private	_client: Chrome \| CDPSession \| CRIConnection \| undefined
private	_initializedPromise: Promise<boolean>
private	_isClosedPromise: Promise<*>
private	_isInitialized: boolean
private	_pageOpts: PageInitOptions
private	_pagePromise: Promise<Page>
private	_sessionFactory: function(): Promise<CDPSession>
private	_targetId: string
private	_targetInfo: Object

Method Summary

Public Methods
public	browser(): Browser
public	browserContext(): BrowserContext
public	close(): Promise<boolean> Closes the target.
public	createCDPSession(): Promise<CDPSession>
public	async exposeDevToolsProtocol(bindingName: string): Promise<void> Inject object to the target's main frame that provides a communication channel with browser target. Injected object will be available as window[bindingName]. The object has the following API: binding.send(json) - a method to send messages over the remote debugging protocol binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses. EXPERIMENTAL
public	getWindowBounds(): Promise<{bounds: WindowBounds, windowId: number}> Get the browser window id and bounds for this target
public	id(): string
public	isBackgroundPageTarget(): boolean Returns T/F indicating if the target is for a background page
public	isBrowserTarget(): boolean Returns T/F indicating if the target is for a browser
public	isPageTarget(): boolean Returns T/F indicating if the target is for a page
public	isServiceWorkerTarget(): boolean Returns T/F indicating if the target is for a service worker
public	opener(): Target
public	openerId(): string
public	page(): Promise<Page\|undefined>
public	async setWindowBounds(windowId: number, bounds: WindowBounds): Promise<void> Set position and/or size of the browser window.
public	toJSON(): Object
public	type(): "page" \| "background_page" \| "service_worker" \| "other" \| "browser"
public	url(): string

Private Methods
private	_targetInfoChanged(targetInfo: Object)

Public Constructors

public constructor(targetInit: TargetInit) source

Params:

Name	Type	Attribute	Description
targetInit	TargetInit	nullable: false

Private Members

private _browserContext: BrowserContext source

private _client: Chrome | CDPSession | CRIConnection | undefined source

private _initializedPromise: Promise<boolean> source

private _isClosedPromise: Promise<*> source

private _isInitialized: boolean source

private _pageOpts: PageInitOptions source

private _pagePromise: Promise<Page> source

private _sessionFactory: function(): Promise<CDPSession> source

private _targetId: string source

private _targetInfo: Object source

Public Methods

public browser(): Browser source

Return:

Browser (nullable: true)

public browserContext(): BrowserContext source

Return:

BrowserContext (nullable: true)

public close(): Promise<boolean> source

Closes the target. If the target is a page that gets closed too.

Return:

Promise<boolean>

public createCDPSession(): Promise<CDPSession> source

Return:

Promise<CDPSession>

public async exposeDevToolsProtocol(bindingName: string): Promise<void> source

Inject object to the target's main frame that provides a communication channel with browser target.

Injected object will be available as window[bindingName].

The object has the following API:

binding.send(json) - a method to send messages over the remote debugging protocol
binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses.

EXPERIMENTAL

Params:

Name	Type	Attribute	Description
bindingName	string	optional	Binding name, 'cdp' if not specified

Return:

Promise<void>

See:

https://chromedevtools.github.io/devtools-protocol/tot/Target#method-exposeDevToolsProtocol

public getWindowBounds(): Promise<{bounds: WindowBounds, windowId: number}> source

Get the browser window id and bounds for this target

Return:

Promise<{bounds: WindowBounds, windowId: number}>

public id(): string source

Return:

string

public isBackgroundPageTarget(): boolean source

Returns T/F indicating if the target is for a background page

Return:

boolean

public isBrowserTarget(): boolean source

Returns T/F indicating if the target is for a browser

Return:

boolean

public isPageTarget(): boolean source

Returns T/F indicating if the target is for a page

Return:

boolean

public isServiceWorkerTarget(): boolean source

Returns T/F indicating if the target is for a service worker

Return:

boolean

public opener(): Target source

Return:

Target (nullable: true)

public openerId(): string source

Return:

string (nullable: true)

public page(): Promise<Page|undefined> source

Return:

Promise<Page|undefined>

public async setWindowBounds(windowId: number, bounds: WindowBounds): Promise<void> source

Set position and/or size of the browser window. EXPERIMENTAL

Params:

Name	Type	Attribute	Description
windowId	number		An browser window id
bounds	WindowBounds		New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.

Return:

Promise<void>

See:

https://chromedevtools.github.io/devtools-protocol/tot/Browser#method-setWindowBounds

public toJSON(): Object source

Return:

Object

public type(): "page" | "background_page" | "service_worker" | "other" | "browser" source

Return:

"page" | "background_page" | "service_worker" | "other" | "browser"

public url(): string source

Return:

string

Private Methods

private _targetInfoChanged(targetInfo: Object) source

Params:

Name	Type	Attribute	Description
targetInfo	Object	nullable: false