chromedp/cdp/network/network.go

825 lines
30 KiB
Go
Raw Normal View History

2017-01-24 15:09:23 +00:00
// Package network provides the Chrome Debugging Protocol
// commands, types, and events for the Network domain.
2017-01-24 15:09:23 +00:00
//
// Network domain allows tracking network activities of the page. It exposes
// information about http, file, data and other requests and responses, their
// headers, bodies, timing, etc.
//
// Generated by the chromedp-gen command.
package network
// Code generated by chromedp-gen. DO NOT EDIT.
2017-01-24 15:09:23 +00:00
import (
"context"
"encoding/base64"
2017-01-26 07:28:34 +00:00
cdp "github.com/knq/chromedp/cdp"
2017-11-22 05:01:27 +00:00
"github.com/knq/chromedp/cdp/debugger"
2017-01-24 15:09:23 +00:00
)
2017-12-18 00:23:14 +00:00
// ClearBrowserCacheParams clears browser cache.
type ClearBrowserCacheParams struct{}
// ClearBrowserCache clears browser cache.
func ClearBrowserCache() *ClearBrowserCacheParams {
return &ClearBrowserCacheParams{}
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// Do executes Network.clearBrowserCache against the provided context and
// target handler.
func (p *ClearBrowserCacheParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkClearBrowserCache, nil, nil)
}
// ClearBrowserCookiesParams clears browser cookies.
type ClearBrowserCookiesParams struct{}
// ClearBrowserCookies clears browser cookies.
func ClearBrowserCookies() *ClearBrowserCookiesParams {
return &ClearBrowserCookiesParams{}
}
// Do executes Network.clearBrowserCookies against the provided context and
// target handler.
func (p *ClearBrowserCookiesParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkClearBrowserCookies, nil, nil)
}
// ContinueInterceptedRequestParams response to Network.requestIntercepted
// which either modifies the request to continue with any modifications, or
// blocks it, or completes it with the provided response bytes. If a network
// fetch occurs as a result which encounters a redirect an additional
// Network.requestIntercepted event will be sent with the same InterceptionId.
type ContinueInterceptedRequestParams struct {
InterceptionID InterceptionID `json:"interceptionId"`
ErrorReason ErrorReason `json:"errorReason,omitempty"` // If set this causes the request to fail with the given reason. Passing Aborted for requests marked with isNavigationRequest also cancels the navigation. Must not be set in response to an authChallenge.
RawResponse string `json:"rawResponse,omitempty"` // If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc... Must not be set in response to an authChallenge.
URL string `json:"url,omitempty"` // If set the request url will be modified in a way that's not observable by page. Must not be set in response to an authChallenge.
Method string `json:"method,omitempty"` // If set this allows the request method to be overridden. Must not be set in response to an authChallenge.
PostData string `json:"postData,omitempty"` // If set this allows postData to be set. Must not be set in response to an authChallenge.
Headers Headers `json:"headers,omitempty"` // If set this allows the request headers to be changed. Must not be set in response to an authChallenge.
AuthChallengeResponse *AuthChallengeResponse `json:"authChallengeResponse,omitempty"` // Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
}
// ContinueInterceptedRequest response to Network.requestIntercepted which
// either modifies the request to continue with any modifications, or blocks it,
// or completes it with the provided response bytes. If a network fetch occurs
// as a result which encounters a redirect an additional
// Network.requestIntercepted event will be sent with the same InterceptionId.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// interceptionID
func ContinueInterceptedRequest(interceptionID InterceptionID) *ContinueInterceptedRequestParams {
return &ContinueInterceptedRequestParams{
InterceptionID: interceptionID,
}
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// WithErrorReason if set this causes the request to fail with the given
// reason. Passing Aborted for requests marked with isNavigationRequest also
// cancels the navigation. Must not be set in response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithErrorReason(errorReason ErrorReason) *ContinueInterceptedRequestParams {
p.ErrorReason = errorReason
2017-01-24 15:09:23 +00:00
return &p
}
2017-12-18 00:23:14 +00:00
// WithRawResponse if set the requests completes using with the provided
// base64 encoded raw response, including HTTP status line and headers etc...
// Must not be set in response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithRawResponse(rawResponse string) *ContinueInterceptedRequestParams {
p.RawResponse = rawResponse
2017-01-24 15:09:23 +00:00
return &p
}
2017-12-18 00:23:14 +00:00
// WithURL if set the request url will be modified in a way that's not
// observable by page. Must not be set in response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithURL(url string) *ContinueInterceptedRequestParams {
p.URL = url
return &p
}
// WithMethod if set this allows the request method to be overridden. Must
// not be set in response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithMethod(method string) *ContinueInterceptedRequestParams {
p.Method = method
return &p
}
// WithPostData if set this allows postData to be set. Must not be set in
// response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithPostData(postData string) *ContinueInterceptedRequestParams {
p.PostData = postData
return &p
}
// WithHeaders if set this allows the request headers to be changed. Must not
// be set in response to an authChallenge.
func (p ContinueInterceptedRequestParams) WithHeaders(headers Headers) *ContinueInterceptedRequestParams {
p.Headers = headers
return &p
}
// WithAuthChallengeResponse response to a requestIntercepted with an
// authChallenge. Must not be set otherwise.
func (p ContinueInterceptedRequestParams) WithAuthChallengeResponse(authChallengeResponse *AuthChallengeResponse) *ContinueInterceptedRequestParams {
p.AuthChallengeResponse = authChallengeResponse
return &p
}
// Do executes Network.continueInterceptedRequest against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *ContinueInterceptedRequestParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkContinueInterceptedRequest, p, nil)
}
// DeleteCookiesParams deletes browser cookies with matching name and url or
// domain/path pair.
type DeleteCookiesParams struct {
Name string `json:"name"` // Name of the cookies to remove.
URL string `json:"url,omitempty"` // If specified, deletes all the cookies with the given name where domain and path match provided URL.
Domain string `json:"domain,omitempty"` // If specified, deletes only cookies with the exact domain.
Path string `json:"path,omitempty"` // If specified, deletes only cookies with the exact path.
}
// DeleteCookies deletes browser cookies with matching name and url or
// domain/path pair.
//
// parameters:
// name - Name of the cookies to remove.
func DeleteCookies(name string) *DeleteCookiesParams {
return &DeleteCookiesParams{
Name: name,
}
}
// WithURL if specified, deletes all the cookies with the given name where
// domain and path match provided URL.
func (p DeleteCookiesParams) WithURL(url string) *DeleteCookiesParams {
p.URL = url
return &p
}
// WithDomain if specified, deletes only cookies with the exact domain.
func (p DeleteCookiesParams) WithDomain(domain string) *DeleteCookiesParams {
p.Domain = domain
return &p
}
// WithPath if specified, deletes only cookies with the exact path.
func (p DeleteCookiesParams) WithPath(path string) *DeleteCookiesParams {
p.Path = path
return &p
}
// Do executes Network.deleteCookies against the provided context and
// target handler.
func (p *DeleteCookiesParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkDeleteCookies, p, nil)
2017-01-24 15:09:23 +00:00
}
// DisableParams disables network tracking, prevents network events from
// being sent to the client.
type DisableParams struct{}
// Disable disables network tracking, prevents network events from being sent
// to the client.
func Disable() *DisableParams {
return &DisableParams{}
}
// Do executes Network.disable against the provided context and
// target handler.
func (p *DisableParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkDisable, nil, nil)
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// EmulateNetworkConditionsParams activates emulation of network conditions.
type EmulateNetworkConditionsParams struct {
Offline bool `json:"offline"` // True to emulate internet disconnection.
Latency float64 `json:"latency"` // Minimum latency from request sent to response headers received (ms).
DownloadThroughput float64 `json:"downloadThroughput"` // Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
UploadThroughput float64 `json:"uploadThroughput"` // Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
ConnectionType ConnectionType `json:"connectionType,omitempty"` // Connection type if known.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// EmulateNetworkConditions activates emulation of network conditions.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// offline - True to emulate internet disconnection.
// latency - Minimum latency from request sent to response headers received (ms).
// downloadThroughput - Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
// uploadThroughput - Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
func EmulateNetworkConditions(offline bool, latency float64, downloadThroughput float64, uploadThroughput float64) *EmulateNetworkConditionsParams {
return &EmulateNetworkConditionsParams{
Offline: offline,
Latency: latency,
DownloadThroughput: downloadThroughput,
UploadThroughput: uploadThroughput,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// WithConnectionType connection type if known.
func (p EmulateNetworkConditionsParams) WithConnectionType(connectionType ConnectionType) *EmulateNetworkConditionsParams {
p.ConnectionType = connectionType
return &p
}
// Do executes Network.emulateNetworkConditions against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *EmulateNetworkConditionsParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkEmulateNetworkConditions, p, nil)
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// EnableParams enables network tracking, network events will now be
// delivered to the client.
type EnableParams struct {
MaxTotalBufferSize int64 `json:"maxTotalBufferSize,omitempty"` // Buffer size in bytes to use when preserving network payloads (XHRs, etc).
MaxResourceBufferSize int64 `json:"maxResourceBufferSize,omitempty"` // Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
2017-11-22 05:01:27 +00:00
}
2017-12-18 00:23:14 +00:00
// Enable enables network tracking, network events will now be delivered to
// the client.
2017-11-22 05:01:27 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
func Enable() *EnableParams {
return &EnableParams{}
2017-11-22 05:01:27 +00:00
}
2017-12-18 00:23:14 +00:00
// WithMaxTotalBufferSize buffer size in bytes to use when preserving network
// payloads (XHRs, etc).
func (p EnableParams) WithMaxTotalBufferSize(maxTotalBufferSize int64) *EnableParams {
p.MaxTotalBufferSize = maxTotalBufferSize
2017-11-22 05:01:27 +00:00
return &p
}
2017-12-18 00:23:14 +00:00
// WithMaxResourceBufferSize per-resource buffer size in bytes to use when
// preserving network payloads (XHRs, etc).
func (p EnableParams) WithMaxResourceBufferSize(maxResourceBufferSize int64) *EnableParams {
p.MaxResourceBufferSize = maxResourceBufferSize
2017-11-22 05:01:27 +00:00
return &p
}
2017-12-18 00:23:14 +00:00
// Do executes Network.enable against the provided context and
// target handler.
func (p *EnableParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkEnable, p, nil)
2017-11-22 05:01:27 +00:00
}
2017-12-18 00:23:14 +00:00
// GetAllCookiesParams returns all browser cookies. Depending on the backend
// support, will return detailed cookie information in the cookies field.
type GetAllCookiesParams struct{}
// GetAllCookies returns all browser cookies. Depending on the backend
// support, will return detailed cookie information in the cookies field.
func GetAllCookies() *GetAllCookiesParams {
return &GetAllCookiesParams{}
}
// GetAllCookiesReturns return values.
type GetAllCookiesReturns struct {
Cookies []*Cookie `json:"cookies,omitempty"` // Array of cookie objects.
}
// Do executes Network.getAllCookies against the provided context and
2017-11-22 05:01:27 +00:00
// target handler.
//
// returns:
2017-12-18 00:23:14 +00:00
// cookies - Array of cookie objects.
func (p *GetAllCookiesParams) Do(ctxt context.Context, h cdp.Handler) (cookies []*Cookie, err error) {
2017-11-22 05:01:27 +00:00
// execute
2017-12-18 00:23:14 +00:00
var res GetAllCookiesReturns
err = h.Execute(ctxt, cdp.CommandNetworkGetAllCookies, nil, &res)
2017-11-22 05:01:27 +00:00
if err != nil {
return nil, err
}
2017-12-18 00:23:14 +00:00
return res.Cookies, nil
2017-11-22 05:01:27 +00:00
}
2017-12-18 00:23:14 +00:00
// GetCertificateParams returns the DER-encoded certificate.
type GetCertificateParams struct {
Origin string `json:"origin"` // Origin to get certificate for.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// GetCertificate returns the DER-encoded certificate.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// origin - Origin to get certificate for.
func GetCertificate(origin string) *GetCertificateParams {
return &GetCertificateParams{
Origin: origin,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// GetCertificateReturns return values.
type GetCertificateReturns struct {
TableNames []string `json:"tableNames,omitempty"`
}
// Do executes Network.getCertificate against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
//
// returns:
// tableNames
func (p *GetCertificateParams) Do(ctxt context.Context, h cdp.Handler) (tableNames []string, err error) {
// execute
var res GetCertificateReturns
err = h.Execute(ctxt, cdp.CommandNetworkGetCertificate, p, &res)
if err != nil {
return nil, err
}
return res.TableNames, nil
}
// GetCookiesParams returns all browser cookies for the current URL.
// Depending on the backend support, will return detailed cookie information in
// the cookies field.
type GetCookiesParams struct {
Urls []string `json:"urls,omitempty"` // The list of URLs for which applicable cookies will be fetched
}
// GetCookies returns all browser cookies for the current URL. Depending on
// the backend support, will return detailed cookie information in the cookies
// field.
//
// parameters:
func GetCookies() *GetCookiesParams {
return &GetCookiesParams{}
}
// WithUrls the list of URLs for which applicable cookies will be fetched.
func (p GetCookiesParams) WithUrls(urls []string) *GetCookiesParams {
p.Urls = urls
return &p
}
// GetCookiesReturns return values.
type GetCookiesReturns struct {
Cookies []*Cookie `json:"cookies,omitempty"` // Array of cookie objects.
}
// Do executes Network.getCookies against the provided context and
// target handler.
//
// returns:
// cookies - Array of cookie objects.
func (p *GetCookiesParams) Do(ctxt context.Context, h cdp.Handler) (cookies []*Cookie, err error) {
// execute
var res GetCookiesReturns
err = h.Execute(ctxt, cdp.CommandNetworkGetCookies, p, &res)
if err != nil {
return nil, err
}
return res.Cookies, nil
2017-01-24 15:09:23 +00:00
}
// GetResponseBodyParams returns content served for the given request.
type GetResponseBodyParams struct {
RequestID RequestID `json:"requestId"` // Identifier of the network request to get content for.
}
// GetResponseBody returns content served for the given request.
//
// parameters:
2017-01-26 07:28:34 +00:00
// requestID - Identifier of the network request to get content for.
func GetResponseBody(requestID RequestID) *GetResponseBodyParams {
2017-01-24 15:09:23 +00:00
return &GetResponseBodyParams{
2017-01-26 07:28:34 +00:00
RequestID: requestID,
2017-01-24 15:09:23 +00:00
}
}
// GetResponseBodyReturns return values.
type GetResponseBodyReturns struct {
Body string `json:"body,omitempty"` // Response body.
Base64encoded bool `json:"base64Encoded,omitempty"` // True, if content was sent as base64.
}
// Do executes Network.getResponseBody against the provided context and
// target handler.
2017-01-24 15:09:23 +00:00
//
// returns:
// body - Response body.
func (p *GetResponseBodyParams) Do(ctxt context.Context, h cdp.Handler) (body []byte, err error) {
// execute
var res GetResponseBodyReturns
err = h.Execute(ctxt, cdp.CommandNetworkGetResponseBody, p, &res)
2017-01-24 15:09:23 +00:00
if err != nil {
return nil, err
}
// decode
var dec []byte
if res.Base64encoded {
dec, err = base64.StdEncoding.DecodeString(res.Body)
if err != nil {
return nil, err
2017-01-24 15:09:23 +00:00
}
} else {
dec = []byte(res.Body)
2017-01-24 15:09:23 +00:00
}
return dec, nil
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// GetResponseBodyForInterceptionParams returns content served for the given
// currently intercepted request.
type GetResponseBodyForInterceptionParams struct {
InterceptionID InterceptionID `json:"interceptionId"` // Identifier for the intercepted request to get body for.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// GetResponseBodyForInterception returns content served for the given
// currently intercepted request.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// interceptionID - Identifier for the intercepted request to get body for.
func GetResponseBodyForInterception(interceptionID InterceptionID) *GetResponseBodyForInterceptionParams {
return &GetResponseBodyForInterceptionParams{
InterceptionID: interceptionID,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// GetResponseBodyForInterceptionReturns return values.
type GetResponseBodyForInterceptionReturns struct {
Body string `json:"body,omitempty"` // Response body.
Base64encoded bool `json:"base64Encoded,omitempty"` // True, if content was sent as base64.
}
// Do executes Network.getResponseBodyForInterception against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
//
// returns:
// body - Response body.
func (p *GetResponseBodyForInterceptionParams) Do(ctxt context.Context, h cdp.Handler) (body []byte, err error) {
// execute
var res GetResponseBodyForInterceptionReturns
err = h.Execute(ctxt, cdp.CommandNetworkGetResponseBodyForInterception, p, &res)
if err != nil {
return nil, err
}
// decode
var dec []byte
if res.Base64encoded {
dec, err = base64.StdEncoding.DecodeString(res.Body)
if err != nil {
return nil, err
}
} else {
dec = []byte(res.Body)
}
return dec, nil
2017-01-24 15:09:23 +00:00
}
// ReplayXHRParams this method sends a new XMLHttpRequest which is identical
// to the original one. The following parameters should be identical: method,
// url, async, request body, extra headers, withCredentials attribute, user,
// password.
type ReplayXHRParams struct {
RequestID RequestID `json:"requestId"` // Identifier of XHR to replay.
}
// ReplayXHR this method sends a new XMLHttpRequest which is identical to the
// original one. The following parameters should be identical: method, url,
2017-12-18 00:23:14 +00:00
// async, request body, extra headers, withCredentials attribute, user,
// password.
//
// parameters:
// requestID - Identifier of XHR to replay.
func ReplayXHR(requestID RequestID) *ReplayXHRParams {
return &ReplayXHRParams{
RequestID: requestID,
}
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// Do executes Network.replayXHR against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *ReplayXHRParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkReplayXHR, p, nil)
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SearchInResponseBodyParams searches for given string in response content.
type SearchInResponseBodyParams struct {
RequestID RequestID `json:"requestId"` // Identifier of the network response to search.
Query string `json:"query"` // String to search for.
CaseSensitive bool `json:"caseSensitive,omitempty"` // If true, search is case sensitive.
IsRegex bool `json:"isRegex,omitempty"` // If true, treats string parameter as regex.
}
2017-01-24 15:09:23 +00:00
2017-12-18 00:23:14 +00:00
// SearchInResponseBody searches for given string in response content.
//
// parameters:
2017-12-18 00:23:14 +00:00
// requestID - Identifier of the network response to search.
// query - String to search for.
func SearchInResponseBody(requestID RequestID, query string) *SearchInResponseBodyParams {
return &SearchInResponseBodyParams{
RequestID: requestID,
Query: query,
}
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// WithCaseSensitive if true, search is case sensitive.
func (p SearchInResponseBodyParams) WithCaseSensitive(caseSensitive bool) *SearchInResponseBodyParams {
p.CaseSensitive = caseSensitive
return &p
}
2017-12-18 00:23:14 +00:00
// WithIsRegex if true, treats string parameter as regex.
func (p SearchInResponseBodyParams) WithIsRegex(isRegex bool) *SearchInResponseBodyParams {
p.IsRegex = isRegex
return &p
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SearchInResponseBodyReturns return values.
type SearchInResponseBodyReturns struct {
Result []*debugger.SearchMatch `json:"result,omitempty"` // List of search matches.
}
// Do executes Network.searchInResponseBody against the provided context and
// target handler.
2017-01-24 15:09:23 +00:00
//
// returns:
2017-12-18 00:23:14 +00:00
// result - List of search matches.
func (p *SearchInResponseBodyParams) Do(ctxt context.Context, h cdp.Handler) (result []*debugger.SearchMatch, err error) {
// execute
2017-12-18 00:23:14 +00:00
var res SearchInResponseBodyReturns
err = h.Execute(ctxt, cdp.CommandNetworkSearchInResponseBody, p, &res)
if err != nil {
return nil, err
}
2017-12-18 00:23:14 +00:00
return res.Result, nil
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetBlockedURLSParams blocks URLs from loading.
type SetBlockedURLSParams struct {
Urls []string `json:"urls"` // URL patterns to block. Wildcards ('*') are allowed.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetBlockedURLS blocks URLs from loading.
2017-01-24 15:09:23 +00:00
//
2017-12-18 00:23:14 +00:00
// parameters:
// urls - URL patterns to block. Wildcards ('*') are allowed.
func SetBlockedURLS(urls []string) *SetBlockedURLSParams {
return &SetBlockedURLSParams{
Urls: urls,
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
}
2017-01-24 15:09:23 +00:00
2017-12-18 00:23:14 +00:00
// Do executes Network.setBlockedURLs against the provided context and
// target handler.
func (p *SetBlockedURLSParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetBlockedURLS, p, nil)
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetBypassServiceWorkerParams toggles ignoring of service worker for each
// request.
type SetBypassServiceWorkerParams struct {
Bypass bool `json:"bypass"` // Bypass service worker and load from network.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetBypassServiceWorker toggles ignoring of service worker for each
// request.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// bypass - Bypass service worker and load from network.
func SetBypassServiceWorker(bypass bool) *SetBypassServiceWorkerParams {
return &SetBypassServiceWorkerParams{
Bypass: bypass,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setBypassServiceWorker against the provided context and
// target handler.
func (p *SetBypassServiceWorkerParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetBypassServiceWorker, p, nil)
2017-08-20 23:56:21 +00:00
}
2017-12-18 00:23:14 +00:00
// SetCacheDisabledParams toggles ignoring cache for each request. If true,
// cache will not be used.
type SetCacheDisabledParams struct {
CacheDisabled bool `json:"cacheDisabled"` // Cache disabled state.
2017-08-20 23:56:21 +00:00
}
2017-12-18 00:23:14 +00:00
// SetCacheDisabled toggles ignoring cache for each request. If true, cache
// will not be used.
//
// parameters:
// cacheDisabled - Cache disabled state.
func SetCacheDisabled(cacheDisabled bool) *SetCacheDisabledParams {
return &SetCacheDisabledParams{
CacheDisabled: cacheDisabled,
}
2017-08-20 23:56:21 +00:00
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setCacheDisabled against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *SetCacheDisabledParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetCacheDisabled, p, nil)
2017-01-24 15:09:23 +00:00
}
// SetCookieParams sets a cookie with the given cookie data; may overwrite
// equivalent cookies if they exist.
type SetCookieParams struct {
2017-08-20 23:56:21 +00:00
Name string `json:"name"` // Cookie name.
Value string `json:"value"` // Cookie value.
URL string `json:"url,omitempty"` // The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie.
Domain string `json:"domain,omitempty"` // Cookie domain.
Path string `json:"path,omitempty"` // Cookie path.
Secure bool `json:"secure,omitempty"` // True if cookie is secure.
HTTPOnly bool `json:"httpOnly,omitempty"` // True if cookie is http-only.
SameSite CookieSameSite `json:"sameSite,omitempty"` // Cookie SameSite type.
Expires *cdp.TimeSinceEpoch `json:"expires,omitempty"` // Cookie expiration date, session cookie if not set
2017-01-24 15:09:23 +00:00
}
// SetCookie sets a cookie with the given cookie data; may overwrite
// equivalent cookies if they exist.
//
// parameters:
2017-08-20 23:56:21 +00:00
// name - Cookie name.
// value - Cookie value.
func SetCookie(name string, value string) *SetCookieParams {
2017-01-24 15:09:23 +00:00
return &SetCookieParams{
Name: name,
Value: value,
}
}
2017-08-20 23:56:21 +00:00
// WithURL the request-URI to associate with the setting of the cookie. This
// value can affect the default domain and path values of the created cookie.
func (p SetCookieParams) WithURL(url string) *SetCookieParams {
p.URL = url
return &p
}
// WithDomain cookie domain.
2017-01-24 15:09:23 +00:00
func (p SetCookieParams) WithDomain(domain string) *SetCookieParams {
p.Domain = domain
return &p
}
2017-08-20 23:56:21 +00:00
// WithPath cookie path.
2017-01-24 15:09:23 +00:00
func (p SetCookieParams) WithPath(path string) *SetCookieParams {
p.Path = path
return &p
}
2017-12-18 00:23:14 +00:00
// WithSecure true if cookie is secure.
func (p SetCookieParams) WithSecure(secure bool) *SetCookieParams {
p.Secure = secure
return &p
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// WithHTTPOnly true if cookie is http-only.
func (p SetCookieParams) WithHTTPOnly(httpOnly bool) *SetCookieParams {
p.HTTPOnly = httpOnly
2017-01-24 15:09:23 +00:00
return &p
}
2017-12-18 00:23:14 +00:00
// WithSameSite cookie SameSite type.
func (p SetCookieParams) WithSameSite(sameSite CookieSameSite) *SetCookieParams {
p.SameSite = sameSite
return &p
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// WithExpires cookie expiration date, session cookie if not set.
func (p SetCookieParams) WithExpires(expires *cdp.TimeSinceEpoch) *SetCookieParams {
p.Expires = expires
return &p
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetCookieReturns return values.
type SetCookieReturns struct {
Success bool `json:"success,omitempty"` // True if successfully set cookie.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setCookie against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
//
// returns:
// success - True if successfully set cookie.
func (p *SetCookieParams) Do(ctxt context.Context, h cdp.Handler) (success bool, err error) {
// execute
var res SetCookieReturns
err = h.Execute(ctxt, cdp.CommandNetworkSetCookie, p, &res)
if err != nil {
return false, err
}
return res.Success, nil
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetCookiesParams sets given cookies.
type SetCookiesParams struct {
Cookies []*CookieParam `json:"cookies"` // Cookies to be set.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetCookies sets given cookies.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// cookies - Cookies to be set.
func SetCookies(cookies []*CookieParam) *SetCookiesParams {
return &SetCookiesParams{
Cookies: cookies,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setCookies against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *SetCookiesParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetCookies, p, nil)
2017-01-24 15:09:23 +00:00
}
// SetDataSizeLimitsForTestParams for testing.
type SetDataSizeLimitsForTestParams struct {
MaxTotalSize int64 `json:"maxTotalSize"` // Maximum total buffer size.
MaxResourceSize int64 `json:"maxResourceSize"` // Maximum per-resource size.
}
// SetDataSizeLimitsForTest for testing.
//
// parameters:
// maxTotalSize - Maximum total buffer size.
// maxResourceSize - Maximum per-resource size.
func SetDataSizeLimitsForTest(maxTotalSize int64, maxResourceSize int64) *SetDataSizeLimitsForTestParams {
return &SetDataSizeLimitsForTestParams{
MaxTotalSize: maxTotalSize,
MaxResourceSize: maxResourceSize,
}
}
// Do executes Network.setDataSizeLimitsForTest against the provided context and
// target handler.
func (p *SetDataSizeLimitsForTestParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetDataSizeLimitsForTest, p, nil)
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetExtraHTTPHeadersParams specifies whether to always send extra HTTP
// headers with the requests from this page.
type SetExtraHTTPHeadersParams struct {
Headers Headers `json:"headers"` // Map with extra HTTP headers.
2017-01-24 15:09:23 +00:00
}
2017-12-18 00:23:14 +00:00
// SetExtraHTTPHeaders specifies whether to always send extra HTTP headers
// with the requests from this page.
2017-01-24 15:09:23 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// headers - Map with extra HTTP headers.
func SetExtraHTTPHeaders(headers Headers) *SetExtraHTTPHeadersParams {
return &SetExtraHTTPHeadersParams{
Headers: headers,
2017-01-24 15:09:23 +00:00
}
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setExtraHTTPHeaders against the provided context and
// target handler.
2017-12-18 00:23:14 +00:00
func (p *SetExtraHTTPHeadersParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetExtraHTTPHeaders, p, nil)
2017-01-24 15:09:23 +00:00
}
2017-06-06 10:57:18 +00:00
2017-10-24 02:06:01 +00:00
// SetRequestInterceptionParams sets the requests to intercept that match a
// the provided patterns and optionally resource types.
type SetRequestInterceptionParams struct {
Patterns []*RequestPattern `json:"patterns"` // Requests matching any of these patterns will be forwarded and wait for the corresponding continueInterceptedRequest call.
2017-06-06 10:57:18 +00:00
}
2017-10-24 02:06:01 +00:00
// SetRequestInterception sets the requests to intercept that match a the
// provided patterns and optionally resource types.
2017-06-06 10:57:18 +00:00
//
// parameters:
2017-10-24 02:06:01 +00:00
// patterns - Requests matching any of these patterns will be forwarded and wait for the corresponding continueInterceptedRequest call.
func SetRequestInterception(patterns []*RequestPattern) *SetRequestInterceptionParams {
return &SetRequestInterceptionParams{
Patterns: patterns,
2017-06-06 10:57:18 +00:00
}
}
2017-10-24 02:06:01 +00:00
// Do executes Network.setRequestInterception against the provided context and
2017-06-06 10:57:18 +00:00
// target handler.
2017-10-24 02:06:01 +00:00
func (p *SetRequestInterceptionParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetRequestInterception, p, nil)
2017-06-06 10:57:18 +00:00
}
2017-12-18 00:23:14 +00:00
// SetUserAgentOverrideParams allows overriding user agent with the given
// string.
type SetUserAgentOverrideParams struct {
UserAgent string `json:"userAgent"` // User agent to use.
2017-11-22 05:01:27 +00:00
}
2017-12-18 00:23:14 +00:00
// SetUserAgentOverride allows overriding user agent with the given string.
2017-11-22 05:01:27 +00:00
//
// parameters:
2017-12-18 00:23:14 +00:00
// userAgent - User agent to use.
func SetUserAgentOverride(userAgent string) *SetUserAgentOverrideParams {
return &SetUserAgentOverrideParams{
UserAgent: userAgent,
2017-11-22 05:01:27 +00:00
}
}
2017-12-18 00:23:14 +00:00
// Do executes Network.setUserAgentOverride against the provided context and
2017-11-22 05:01:27 +00:00
// target handler.
2017-12-18 00:23:14 +00:00
func (p *SetUserAgentOverrideParams) Do(ctxt context.Context, h cdp.Handler) (err error) {
return h.Execute(ctxt, cdp.CommandNetworkSetUserAgentOverride, p, nil)
2017-11-22 05:01:27 +00:00
}