Tools to Work with the 'Splash' JavaScript Rendering Service in R
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

81 lines
3.0 KiB

5 years ago
% Generated by roxygen2: do not edit by hand
3 years ago
% Please edit documentation in R/render-har.R
5 years ago
\name{render_har}
\alias{render_har}
\title{Return information about Splash interaction with a website in HAR format.}
\usage{
render_har(splash_obj = splash_local, url, base_url,
response_body = FALSE, timeout = 30, resource_timeout, wait = 0,
proxy, js, js_src, filters, allowed_domains, allowed_content_types,
forbidden_content_types, viewport = "1024x768", images, headers, body,
http_method, save_args, load_args)
5 years ago
}
\arguments{
\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
5 years ago
\item{url}{The URL to render (required)}
\item{base_url}{The base url to render the page with.}
\item{response_body}{When \code{TRUE}, response content is included in the HAR records}
5 years ago
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}
5 years ago
\item{resource_timeout}{A timeout (in seconds) for individual network requests.}
\item{wait}{Time (in seconds) to wait for updates after page is loaded (defaults to 0).}
\item{proxy}{Proxy profile name or proxy URL.}
\item{js}{Javascript profile name.}
\item{js_src}{JavaScript code to be executed in page context.}
\item{filters}{Comma-separated list of request filter names.}
5 years ago
\item{allowed_domains}{Comma-separated list of allowed domain names. If present, Splash
won’t load anything neither from domains not in this list nor from subdomains of
domains not in this list.}
5 years ago
5 years ago
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}
5 years ago
5 years ago
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}
5 years ago
5 years ago
\item{viewport}{View width and height (in pixels) of the browser viewport to render the
web page. Format is “<width>x<height>”, e.g. 800x600. Default value is "full".}
5 years ago
\item{images}{Whether to download images.}
\item{headers}{HTTP headers to set for the first outgoing request.}
\item{body}{Body of HTTP POST request to be sent if method is POST.}
\item{http_method}{HTTP method of outgoing Splash request.}
\item{save_args}{A list of argument names to put in cache.}
\item{load_args}{Parameter values to load from cache}
}
5 years ago
\value{
a \link{HARtools} \code{har} object
5 years ago
}
5 years ago
\description{
It includes information about requests made, responses received, timings, headers, etc and
5 years ago
is incredibly detailed, full of information on every component loaded.
5 years ago
}
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
5 years ago
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_html}}, \code{\link{render_jpeg}},
\code{\link{render_json}}, \code{\link{render_png}}
5 years ago
}
5 years ago
\concept{splash_renderers}