default

false

default

false

if set to true, rewrites your request to disable content-security-policy, xss protection, and CORS, assuming that webSecurityEnabled and xssAuditingEnabled settings do not conflict..

IMPORTANT This is an experimental feature, which is why it is FALSE by default. when it is more stable, it will be on by default and will need to be turned off via enableSecureHeaders

default

false

Render the page early, once a specific criteria is found on the page.

Syntax: doneWhen = Array of IDoneWhen objects.

Experimental: There are some bugs, and this future may be adjusted in the comming months based on usage feedback. If you have any comments/questions, please email Support@PhantomJsCloud.com

As soon as your criteria is met, will trigger the completion of your apge (But still respects waitInterval delay and in-progress injected scripts). If the all the criteria is not met, the page will continue waiting, until the maxWait is timeout reached.

You may pass an array so that you can detect modify the response status code, and whichever element matches will be noted in the userResponse.content.doneWhen node, and in the pjsc-content-done-when HTTP Response Header.

Usage Notes:

1) each doneWhen element may have one or more criteria. All criteria must be met for the load to be considered done. Pass multiple array elements if you want "OR" style functionality.

2) Scanning for your critera is performed aproximately every 50ms. This means that rapid changes to the web page may be overlooked.

3) If you need finer control of completion use IScriptPjscMeta.manualWait and/or IScriptPjscMeta.forceFinish by injecting a custom script via IPageRequest.scripts.

example

{
url:"https://PhantomJsCloud.com/examples/corpus/ajax.html",
"requestSettings":{
"doneWhen":[
{"text":'"statusCode":206',statusCode:202},
{"selector":"pre#fill-target",statusCode:201},
],
waitInterval:0,
},
renderSettings:{
passThroughStatusCode:true,
},
}

maximum amount of time (in ms) to wait when communicating with the browser, such as when retrieving iframes or cookies, detecting page height, etc. Default is 2000ms. You usually will not need to change this, unless dealing with JSON output and very large/complex pages.

When rendering a page, we will give you whatever is ready at this time (page may be incompletely loaded).

Can be increased up to 5 minutes (300000) , but that only should be used as a last resort, as it is a relatively expensive page render (you are billed for render time).

if this value is exceeded, the current page will be rendered "normally" (status 200), however you may inspect the target page's status code by looking at pjsc-content-status-code header, or content.statusCode if outputting as JSON.

A regex. If it maches a resource's response URL, we will record the response body in base64 format, stored in the output JSON under the pageResponses.events (key=response) node.

For advanced use. This is useful when you want to inspect data sent to your page, but is otherwise not rendered in the page output.

example

{
"url": "https://www.example.com",
"renderType": "jpeg",
"outputAsJson": true,
"requestSettings": {
"recordResourceBody": "https\\://www.example.com.*" //if you need an escape character (slash) be sure to double-escape, as shown in this example
}
}

example:

//screenshot of amazon.com using a random ip, without images, fonts, or css
{
url:"https://www.amazon.com",
renderType:"jpeg",
proxy:"anon-any",
requestSettings:{
resourceModifier:[
{type:"stylesheet" ,isBlacklisted:true},
{type:"font" ,isBlacklisted:true},
{type:"image" ,isBlacklisted:true},
],
},
}

example:

//load a page blacklisting css, and setting additional headers for all resources from mydomain.com
{ url:"http://www.example.com",
requestSettings:{
  "resourceModifier": [{regex:".*css.*",isBlacklisted:true}{"regex": "http://mydomain.com.*","setHeader": {"hello": "world","Accept-encoding": "tacos"}}]
},
}

You may also set the experimental disableSecureHeaders property to further reduce page security.

IMPORTANT: only the first IPageRequest can set this property, and it is reused for the remainder of your request.

default

false

You may also set the experimental disableSecureHeaders property to further reduce page security.

default

false