browser

package
v0.0.0-...-2c452e2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 5, 2018 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package browser provides the Chrome Debugging Protocol commands, types, and events for the Browser domain.

The Browser domain defines methods and events for browser managing.

Generated by the chromedp-gen command.

Index

Constants

View Source 
const (
	CommandClose              = "Browser.close"
	CommandGetVersion         = "Browser.getVersion"
	CommandGetHistograms      = "Browser.getHistograms"
	CommandGetHistogram       = "Browser.getHistogram"
	CommandGetWindowBounds    = "Browser.getWindowBounds"
	CommandGetWindowForTarget = "Browser.getWindowForTarget"
	CommandSetWindowBounds    = "Browser.setWindowBounds"
)

Command names.

Variables

This section is empty.

Functions

This section is empty.

Types

type Bounds 

type Bounds struct {
	Left        int64       `json:"left,omitempty"`        // The offset from the left edge of the screen to the window in pixels.
	Top         int64       `json:"top,omitempty"`         // The offset from the top edge of the screen to the window in pixels.
	Width       int64       `json:"width,omitempty"`       // The window width in pixels.
	Height      int64       `json:"height,omitempty"`      // The window height in pixels.
	WindowState WindowState `json:"windowState,omitempty"` // The window state. Default to normal.
}

Bounds browser window bounds information.

func (Bounds) MarshalEasyJSON 

func (v Bounds) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Bounds) MarshalJSON 

func (v Bounds) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Bounds) UnmarshalEasyJSON 

func (v *Bounds) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Bounds) UnmarshalJSON 

func (v *Bounds) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Bucket 

type Bucket struct {
	Low   int64 `json:"low"`   // Minimum value (inclusive).
	High  int64 `json:"high"`  // Maximum value (exclusive).
	Count int64 `json:"count"` // Number of samples.
}

Bucket chrome histogram bucket.

func (Bucket) MarshalEasyJSON 

func (v Bucket) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Bucket) MarshalJSON 

func (v Bucket) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Bucket) UnmarshalEasyJSON 

func (v *Bucket) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Bucket) UnmarshalJSON 

func (v *Bucket) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type CloseParams 

type CloseParams struct{}

CloseParams close browser gracefully.

func Close 

func Close() *CloseParams

Close close browser gracefully.

func (*CloseParams) Do 

func (p *CloseParams) Do(ctxt context.Context, h cdp.Executor) (err error)

Do executes Browser.close against the provided context.

func (CloseParams) MarshalEasyJSON 

func (v CloseParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CloseParams) MarshalJSON 

func (v CloseParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CloseParams) UnmarshalEasyJSON 

func (v *CloseParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CloseParams) UnmarshalJSON 

func (v *CloseParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetHistogramParams 

type GetHistogramParams struct {
	Name string `json:"name"` // Requested histogram name.
}

GetHistogramParams get a Chrome histogram by name.

func GetHistogram 

func GetHistogram(name string) *GetHistogramParams

GetHistogram get a Chrome histogram by name.

parameters: 

name - Requested histogram name.

func (*GetHistogramParams) Do 

func (p *GetHistogramParams) Do(ctxt context.Context, h cdp.Executor) (histogram *Histogram, err error)

Do executes Browser.getHistogram against the provided context.

returns: 

histogram - Histogram.

func (GetHistogramParams) MarshalEasyJSON 

func (v GetHistogramParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHistogramParams) MarshalJSON 

func (v GetHistogramParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHistogramParams) UnmarshalEasyJSON 

func (v *GetHistogramParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHistogramParams) UnmarshalJSON 

func (v *GetHistogramParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetHistogramReturns 

type GetHistogramReturns struct {
	Histogram *Histogram `json:"histogram,omitempty"` // Histogram.
}

GetHistogramReturns return values.

func (GetHistogramReturns) MarshalEasyJSON 

func (v GetHistogramReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHistogramReturns) MarshalJSON 

func (v GetHistogramReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHistogramReturns) UnmarshalEasyJSON 

func (v *GetHistogramReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHistogramReturns) UnmarshalJSON 

func (v *GetHistogramReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetHistogramsParams 

type GetHistogramsParams struct {
	Query string `json:"query,omitempty"` // Requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.
}

GetHistogramsParams get Chrome histograms.

func GetHistograms 

func GetHistograms() *GetHistogramsParams

GetHistograms get Chrome histograms.

parameters:

func (*GetHistogramsParams) Do 

func (p *GetHistogramsParams) Do(ctxt context.Context, h cdp.Executor) (histograms []*Histogram, err error)

Do executes Browser.getHistograms against the provided context.

returns: 

histograms - Histograms.

func (GetHistogramsParams) MarshalEasyJSON 

func (v GetHistogramsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHistogramsParams) MarshalJSON 

func (v GetHistogramsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHistogramsParams) UnmarshalEasyJSON 

func (v *GetHistogramsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHistogramsParams) UnmarshalJSON 

func (v *GetHistogramsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (GetHistogramsParams) WithQuery 

func (p GetHistogramsParams) WithQuery(query string) *GetHistogramsParams

WithQuery requested substring in name. Only histograms which have query as a substring in their name are extracted. An empty or absent query returns all histograms.

type GetHistogramsReturns 

type GetHistogramsReturns struct {
	Histograms []*Histogram `json:"histograms,omitempty"` // Histograms.
}

GetHistogramsReturns return values.

func (GetHistogramsReturns) MarshalEasyJSON 

func (v GetHistogramsReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHistogramsReturns) MarshalJSON 

func (v GetHistogramsReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHistogramsReturns) UnmarshalEasyJSON 

func (v *GetHistogramsReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHistogramsReturns) UnmarshalJSON 

func (v *GetHistogramsReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVersionParams 

type GetVersionParams struct{}

GetVersionParams returns version information.

func GetVersion 

func GetVersion() *GetVersionParams

GetVersion returns version information.

func (*GetVersionParams) Do 

func (p *GetVersionParams) Do(ctxt context.Context, h cdp.Executor) (protocolVersion string, product string, revision string, userAgent string, jsVersion string, err error)

Do executes Browser.getVersion against the provided context.

returns: 

protocolVersion - Protocol version.
product - Product name.
revision - Product revision.
userAgent - User-Agent.
jsVersion - V8 version.

func (GetVersionParams) MarshalEasyJSON 

func (v GetVersionParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVersionParams) MarshalJSON 

func (v GetVersionParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVersionParams) UnmarshalEasyJSON 

func (v *GetVersionParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVersionParams) UnmarshalJSON 

func (v *GetVersionParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetVersionReturns 

type GetVersionReturns struct {
	ProtocolVersion string `json:"protocolVersion,omitempty"` // Protocol version.
	Product         string `json:"product,omitempty"`         // Product name.
	Revision        string `json:"revision,omitempty"`        // Product revision.
	UserAgent       string `json:"userAgent,omitempty"`       // User-Agent.
	JsVersion       string `json:"jsVersion,omitempty"`       // V8 version.
}

GetVersionReturns return values.

func (GetVersionReturns) MarshalEasyJSON 

func (v GetVersionReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetVersionReturns) MarshalJSON 

func (v GetVersionReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetVersionReturns) UnmarshalEasyJSON 

func (v *GetVersionReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetVersionReturns) UnmarshalJSON 

func (v *GetVersionReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetWindowBoundsParams 

type GetWindowBoundsParams struct {
	WindowID WindowID `json:"windowId"` // Browser window id.
}

GetWindowBoundsParams get position and size of the browser window.

func GetWindowBounds 

func GetWindowBounds(windowID WindowID) *GetWindowBoundsParams

GetWindowBounds get position and size of the browser window.

parameters: 

windowID - Browser window id.

func (*GetWindowBoundsParams) Do 

func (p *GetWindowBoundsParams) Do(ctxt context.Context, h cdp.Executor) (bounds *Bounds, err error)

Do executes Browser.getWindowBounds against the provided context.

returns: 

bounds - Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

func (GetWindowBoundsParams) MarshalEasyJSON 

func (v GetWindowBoundsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetWindowBoundsParams) MarshalJSON 

func (v GetWindowBoundsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetWindowBoundsParams) UnmarshalEasyJSON 

func (v *GetWindowBoundsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetWindowBoundsParams) UnmarshalJSON 

func (v *GetWindowBoundsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetWindowBoundsReturns 

type GetWindowBoundsReturns struct {
	Bounds *Bounds `json:"bounds,omitempty"` // Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
}

GetWindowBoundsReturns return values.

func (GetWindowBoundsReturns) MarshalEasyJSON 

func (v GetWindowBoundsReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetWindowBoundsReturns) MarshalJSON 

func (v GetWindowBoundsReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetWindowBoundsReturns) UnmarshalEasyJSON 

func (v *GetWindowBoundsReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetWindowBoundsReturns) UnmarshalJSON 

func (v *GetWindowBoundsReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetWindowForTargetParams 

type GetWindowForTargetParams struct {
	TargetID target.ID `json:"targetId"` // Devtools agent host id.
}

GetWindowForTargetParams get the browser window that contains the devtools target.

func GetWindowForTarget 

func GetWindowForTarget(targetID target.ID) *GetWindowForTargetParams

GetWindowForTarget get the browser window that contains the devtools target.

parameters: 

targetID - Devtools agent host id.

func (*GetWindowForTargetParams) Do 

func (p *GetWindowForTargetParams) Do(ctxt context.Context, h cdp.Executor) (windowID WindowID, bounds *Bounds, err error)

Do executes Browser.getWindowForTarget against the provided context.

returns: 

windowID - Browser window id.
bounds - Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.

func (GetWindowForTargetParams) MarshalEasyJSON 

func (v GetWindowForTargetParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetWindowForTargetParams) MarshalJSON 

func (v GetWindowForTargetParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetWindowForTargetParams) UnmarshalEasyJSON 

func (v *GetWindowForTargetParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetWindowForTargetParams) UnmarshalJSON 

func (v *GetWindowForTargetParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetWindowForTargetReturns 

type GetWindowForTargetReturns struct {
	WindowID WindowID `json:"windowId,omitempty"` // Browser window id.
	Bounds   *Bounds  `json:"bounds,omitempty"`   // Bounds information of the window. When window state is 'minimized', the restored window position and size are returned.
}

GetWindowForTargetReturns return values.

func (GetWindowForTargetReturns) MarshalEasyJSON 

func (v GetWindowForTargetReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetWindowForTargetReturns) MarshalJSON 

func (v GetWindowForTargetReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetWindowForTargetReturns) UnmarshalEasyJSON 

func (v *GetWindowForTargetReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetWindowForTargetReturns) UnmarshalJSON 

func (v *GetWindowForTargetReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Histogram 

type Histogram struct {
	Name    string    `json:"name"`    // Name.
	Sum     int64     `json:"sum"`     // Sum of sample values.
	Count   int64     `json:"count"`   // Total number of samples.
	Buckets []*Bucket `json:"buckets"` // Buckets.
}

Histogram chrome histogram.

func (Histogram) MarshalEasyJSON 

func (v Histogram) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Histogram) MarshalJSON 

func (v Histogram) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Histogram) UnmarshalEasyJSON 

func (v *Histogram) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Histogram) UnmarshalJSON 

func (v *Histogram) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetWindowBoundsParams 

type SetWindowBoundsParams struct {
	WindowID WindowID `json:"windowId"` // Browser window id.
	Bounds   *Bounds  `json:"bounds"`   // New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
}

SetWindowBoundsParams set position and/or size of the browser window.

func SetWindowBounds 

func SetWindowBounds(windowID WindowID, bounds *Bounds) *SetWindowBoundsParams

SetWindowBounds set position and/or size of the browser window.

parameters: 

windowID - Browser window id.
bounds - New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.

func (*SetWindowBoundsParams) Do 

func (p *SetWindowBoundsParams) Do(ctxt context.Context, h cdp.Executor) (err error)

Do executes Browser.setWindowBounds against the provided context.

func (SetWindowBoundsParams) MarshalEasyJSON 

func (v SetWindowBoundsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetWindowBoundsParams) MarshalJSON 

func (v SetWindowBoundsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetWindowBoundsParams) UnmarshalEasyJSON 

func (v *SetWindowBoundsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetWindowBoundsParams) UnmarshalJSON 

func (v *SetWindowBoundsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type WindowID 

type WindowID int64

WindowID [no description].

func (WindowID) Int64 

func (t WindowID) Int64() int64

Int64 returns the WindowID as int64 value.

type WindowState 

type WindowState string

WindowState the state of the browser window. 

const (
	WindowStateNormal     WindowState = "normal"
	WindowStateMinimized  WindowState = "minimized"
	WindowStateMaximized  WindowState = "maximized"
	WindowStateFullscreen WindowState = "fullscreen"
)

WindowState values.

func (WindowState) MarshalEasyJSON 

func (t WindowState) MarshalEasyJSON(out *jwriter.Writer)

MarshalEasyJSON satisfies easyjson.Marshaler.

func (WindowState) MarshalJSON 

func (t WindowState) MarshalJSON() ([]byte, error)

MarshalJSON satisfies json.Marshaler.

func (WindowState) String 

func (t WindowState) String() string

String returns the WindowState as string value.

func (*WindowState) UnmarshalEasyJSON 

func (t *WindowState) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

func (*WindowState) UnmarshalJSON 

func (t *WindowState) UnmarshalJSON(buf []byte) error

UnmarshalJSON satisfies json.Unmarshaler.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.