Search
Preparing search index...
The search index is not available
DefinitelyTyped
Inherited
Private
Externals
Only exported
WebPage
Interface WebPage
Index
Properties
canGoBack
canGoForward
clipRect
content
cookies
customHeaders
event
focusedFrameName
frameContent
frameName
framePlainText
frameTitle
frameUrl
framesCount
framesName
libraryPath
navigationLocked
offlineStoragePath
offlineStorageQuota
onAlert
onCallback
onClosing
onConfirm
onConsoleMessage
onError
onFilePicker
onInitialized
onLoadFinished
onLoadStarted
onNavigationRequested
onPageCreated
onPrompt
onResourceError
onResourceReceived
onResourceRequested
onUrlChanged
ownsPages
pages
pagesWindowName
paperSize
plainText
scrollPosition
settings
title
url
viewportSize
windowName
zoomFactor
Methods
addCookie
childFramesCount
childFramesName
clearCookies
close
closing
currentFrameName
deleteCookie
evaluate
evaluateAsync
evaluateJavascript
getPage
go
goBack
goForward
includeJs
initialized
injectJs
javaScriptAlertSent
javaScriptConsoleMessageSent
loadFinished
loadStarted
navigationRequested
open
openUrl
rawPageCreated
release
reload
render
renderBase64
resourceReceived
resourceRequested
sendEvent
setContent
stop
switchToChildFrame
switchToFocusedFrame
switchToFrame
switchToMainFrame
switchToParentFrame
uploadFile
urlChanged
Properties
public
canGoBack
:
boolean
public
canGoForward
:
boolean
public
clipRect
:
ClipRect
public
content
:
string
public
cookies
:
Cookie
[]
public
customHeaders
:
{ [name: string]: string; }
(
)
:
string
Returns
string
public
event
:
any
public
focusedFrameName
:
string
public
frameContent
:
string
public
frameName
:
string
public
framePlainText
:
string
public
frameTitle
:
string
public
frameUrl
:
string
public
framesCount
:
number
public
framesName
:
any
public
libraryPath
:
string
public
navigationLocked
:
boolean
public
offlineStoragePath
:
string
public
offlineStorageQuota
:
number
public
onAlert
:
(msg: string) => any
public
onCallback
:
Function
public
onClosing
:
(closingPage: WebPage) => any
public
onConfirm
:
(msg: string) => boolean
public
onConsoleMessage
:
(msg: string, lineNum?: number, sourceId?: string) => any
public
onError
:
(msg: string, trace: string[]) => any
public
onFilePicker
:
(oldFile: string) => string
public
onInitialized
:
() => any
public
onLoadFinished
:
(status: string) => any
public
onLoadStarted
:
() => any
public
onNavigationRequested
:
(url: string, type: string, willNavigate: boolean, main: boolean) => any
public
onPageCreated
:
(newPage: WebPage) => any
public
onPrompt
:
(msg: string, defaultVal: string) => string
public
onResourceError
:
(resourceError: ResourceError) => any
public
onResourceReceived
:
(response: ResourceResponse) => any
public
onResourceRequested
:
(requestData: ResourceRequest, networkRequest: NetworkRequest) => any
public
onUrlChanged
:
(targetUrl: string) => any
public
ownsPages
:
boolean
public
pages
:
WebPage
[]
public
pagesWindowName
:
string
public
paperSize
:
PaperSize
public
plainText
:
string
public
scrollPosition
:
TopLeft
public
settings
:
WebPageSettings
public
title
:
string
public
url
:
string
public
viewportSize
:
Size
public
windowName
:
string
public
zoomFactor
:
number
Methods
public
addCookie
(
cookie
:
Cookie
)
:
boolean
Parameters
cookie:
Cookie
Returns
boolean
public
childFramesCount
(
)
:
number
Returns
number
public
childFramesName
(
)
:
string
Returns
string
public
clearCookies
(
)
public
close
(
)
public
closing
(
closingPage
:
WebPage
)
Parameters
closingPage:
WebPage
public
currentFrameName
(
)
:
string
Returns
string
public
deleteCookie
(
cookieName
:
string
)
:
boolean
Parameters
cookieName:
string
Returns
boolean
public
evaluate
(
fn
:
Function
, args
?:
Array<any>
)
:
any
Parameters
fn:
Function
args?:
Array<any>
optional
Returns
any
public
evaluateAsync
(
fn
:
Function
)
Parameters
fn:
Function
public
evaluateJavascript
(
str
:
string
)
:
any
Parameters
str:
string
Returns
any
public
getPage
(
windowName
:
string
)
:
WebPage
Parameters
windowName:
string
Returns
WebPage
public
go
(
index
:
number
)
Parameters
index:
number
public
goBack
(
)
public
goForward
(
)
public
includeJs
(
url
:
string
, callback
:
Function
)
Parameters
url:
string
callback:
Function
public
initialized
(
)
public
injectJs
(
filename
:
string
)
:
boolean
Parameters
filename:
string
Returns
boolean
public
javaScriptAlertSent
(
msg
:
string
)
Parameters
msg:
string
public
javaScriptConsoleMessageSent
(
msg
:
string
, lineNum
?:
number
, sourceId
?:
string
)
Parameters
msg:
string
lineNum?:
number
optional
sourceId?:
string
optional
public
loadFinished
(
status
:
string
)
Parameters
status:
string
public
loadStarted
(
)
public
navigationRequested
(
url
:
string
, type
:
string
, willNavigate
:
boolean
, main
:
boolean
)
Parameters
url:
string
type:
string
willNavigate:
boolean
main:
boolean
public
open
(
url
:
string
, callback
:
(status: string) => any
)
Parameters
url:
string
callback:
(status: string) => any
public
open
(
url
:
string
, method
:
string
, callback
:
(status: string) => any
)
Parameters
url:
string
method:
string
callback:
(status: string) => any
public
open
(
url
:
string
, method
:
string
, data
:
any
, callback
:
(status: string) => any
)
Parameters
url:
string
method:
string
data:
any
callback:
(status: string) => any
public
openUrl
(
url
:
string
, httpConf
:
any
, settings
:
any
)
Parameters
url:
string
httpConf:
any
settings:
any
public
rawPageCreated
(
newPage
:
WebPage
)
Parameters
newPage:
WebPage
public
release
(
)
public
reload
(
)
public
render
(
filename
:
string
)
Parameters
filename:
string
public
renderBase64
(
format
:
string
)
:
string
Parameters
format:
string
Returns
string
public
resourceReceived
(
response
:
ResourceResponse
)
Parameters
response:
ResourceResponse
public
resourceRequested
(
requestData
:
ResourceRequest
, networkRequest
:
NetworkRequest
)
Parameters
requestData:
ResourceRequest
networkRequest:
NetworkRequest
public
sendEvent
(
mouseEventType
:
string
, mouseX
?:
number
, mouseY
?:
number
, button
?:
string
)
Parameters
mouseEventType:
string
mouseX?:
number
optional
mouseY?:
number
optional
button?:
string
optional
public
sendEvent
(
keyboardEventType
:
string
, keyOrKeys
:
any
, aNull
?:
any
, bNull
?:
any
, modifier
?:
number
)
Parameters
keyboardEventType:
string
keyOrKeys:
any
aNull?:
any
optional
bNull?:
any
optional
modifier?:
number
optional
public
setContent
(
content
:
string
, url
:
string
)
Parameters
content:
string
url:
string
public
stop
(
)
public
switchToChildFrame
(
frameName
:
string
)
Parameters
frameName:
string
public
switchToChildFrame
(
framePosition
:
number
)
Parameters
framePosition:
number
public
switchToFocusedFrame
(
)
public
switchToFrame
(
frameName
:
string
)
Parameters
frameName:
string
public
switchToFrame
(
framePosition
:
number
)
Parameters
framePosition:
number
public
switchToMainFrame
(
)
public
switchToParentFrame
(
)
public
uploadFile
(
selector
:
string
, filename
:
string
)
Parameters
selector:
string
filename:
string
public
urlChanged
(
targetUrl
:
string
)
Parameters
targetUrl:
string
Globals