target

package
Version: v0.0.0-...-5fc0351 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2019 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package target provides the Chrome DevTools Protocol commands, types, and events for the Target domain.

Supports additional targets discovery and allows to attach to them.

Generated by the cdproto-gen command.

Index

Constants

View Source
const (
	CommandActivateTarget         = "Target.activateTarget"
	CommandAttachToTarget         = "Target.attachToTarget"
	CommandAttachToBrowserTarget  = "Target.attachToBrowserTarget"
	CommandCloseTarget            = "Target.closeTarget"
	CommandExposeDevToolsProtocol = "Target.exposeDevToolsProtocol"
	CommandCreateBrowserContext   = "Target.createBrowserContext"
	CommandGetBrowserContexts     = "Target.getBrowserContexts"
	CommandCreateTarget           = "Target.createTarget"
	CommandDetachFromTarget       = "Target.detachFromTarget"
	CommandDisposeBrowserContext  = "Target.disposeBrowserContext"
	CommandGetTargetInfo          = "Target.getTargetInfo"
	CommandGetTargets             = "Target.getTargets"
	CommandSetAutoAttach          = "Target.setAutoAttach"
	CommandSetDiscoverTargets     = "Target.setDiscoverTargets"
	CommandSetRemoteLocations     = "Target.setRemoteLocations"
)

Command names.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateTargetParams

type ActivateTargetParams struct {
	TargetID ID `json:"targetId"`
}

ActivateTargetParams activates (focuses) the target.

func ActivateTarget

func ActivateTarget(targetID ID) *ActivateTargetParams

ActivateTarget activates (focuses) the target.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-activateTarget

parameters:

targetID

func (*ActivateTargetParams) Do

func (p *ActivateTargetParams) Do(ctx context.Context) (err error)

Do executes Target.activateTarget against the provided context.

func (ActivateTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (ActivateTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*ActivateTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*ActivateTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type AttachToBrowserTargetParams

type AttachToBrowserTargetParams struct{}

AttachToBrowserTargetParams attaches to the browser target, only uses flat sessionId mode.

func AttachToBrowserTarget

func AttachToBrowserTarget() *AttachToBrowserTargetParams

AttachToBrowserTarget attaches to the browser target, only uses flat sessionId mode.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-attachToBrowserTarget

func (*AttachToBrowserTargetParams) Do

func (p *AttachToBrowserTargetParams) Do(ctx context.Context) (sessionID SessionID, err error)

Do executes Target.attachToBrowserTarget against the provided context.

returns:

sessionID - Id assigned to the session.

func (AttachToBrowserTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (AttachToBrowserTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*AttachToBrowserTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*AttachToBrowserTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type AttachToBrowserTargetReturns

type AttachToBrowserTargetReturns struct {
	SessionID SessionID `json:"sessionId,omitempty"` // Id assigned to the session.
}

AttachToBrowserTargetReturns return values.

func (AttachToBrowserTargetReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (AttachToBrowserTargetReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*AttachToBrowserTargetReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*AttachToBrowserTargetReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type AttachToTargetParams

type AttachToTargetParams struct {
	TargetID ID   `json:"targetId"`
	Flatten  bool `json:"flatten,omitempty"` // Enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.
}

AttachToTargetParams attaches to the target with given id.

func AttachToTarget

func AttachToTarget(targetID ID) *AttachToTargetParams

AttachToTarget attaches to the target with given id.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-attachToTarget

parameters:

targetID

func (*AttachToTargetParams) Do

func (p *AttachToTargetParams) Do(ctx context.Context) (sessionID SessionID, err error)

Do executes Target.attachToTarget against the provided context.

returns:

sessionID - Id assigned to the session.

func (AttachToTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (AttachToTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*AttachToTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*AttachToTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (AttachToTargetParams) WithFlatten

func (p AttachToTargetParams) WithFlatten(flatten bool) *AttachToTargetParams

WithFlatten enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.

type AttachToTargetReturns

type AttachToTargetReturns struct {
	SessionID SessionID `json:"sessionId,omitempty"` // Id assigned to the session.
}

AttachToTargetReturns return values.

func (AttachToTargetReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (AttachToTargetReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*AttachToTargetReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*AttachToTargetReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type BrowserContextID

type BrowserContextID string

BrowserContextID [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#type-BrowserContextID

func (BrowserContextID) String

func (t BrowserContextID) String() string

String returns the BrowserContextID as string value.

type CloseTargetParams

type CloseTargetParams struct {
	TargetID ID `json:"targetId"`
}

CloseTargetParams closes the target. If the target is a page that gets closed too.

func CloseTarget

func CloseTarget(targetID ID) *CloseTargetParams

CloseTarget closes the target. If the target is a page that gets closed too.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-closeTarget

parameters:

targetID

func (*CloseTargetParams) Do

func (p *CloseTargetParams) Do(ctx context.Context) (success bool, err error)

Do executes Target.closeTarget against the provided context.

returns:

success

func (CloseTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CloseTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CloseTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CloseTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type CloseTargetReturns

type CloseTargetReturns struct {
	Success bool `json:"success,omitempty"`
}

CloseTargetReturns return values.

func (CloseTargetReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CloseTargetReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CloseTargetReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CloseTargetReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type CreateBrowserContextParams

type CreateBrowserContextParams struct{}

CreateBrowserContextParams creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

func CreateBrowserContext

func CreateBrowserContext() *CreateBrowserContextParams

CreateBrowserContext creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-createBrowserContext

func (*CreateBrowserContextParams) Do

func (p *CreateBrowserContextParams) Do(ctx context.Context) (browserContextID BrowserContextID, err error)

Do executes Target.createBrowserContext against the provided context.

returns:

browserContextID - The id of the context created.

func (CreateBrowserContextParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateBrowserContextParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CreateBrowserContextParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateBrowserContextParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type CreateBrowserContextReturns

type CreateBrowserContextReturns struct {
	BrowserContextID BrowserContextID `json:"browserContextId,omitempty"` // The id of the context created.
}

CreateBrowserContextReturns return values.

func (CreateBrowserContextReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateBrowserContextReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CreateBrowserContextReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateBrowserContextReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type CreateTargetParams

type CreateTargetParams struct {
	URL                     string           `json:"url"`                               // The initial URL the page will be navigated to.
	Width                   int64            `json:"width,omitempty"`                   // Frame width in DIP (headless chrome only).
	Height                  int64            `json:"height,omitempty"`                  // Frame height in DIP (headless chrome only).
	BrowserContextID        BrowserContextID `json:"browserContextId,omitempty"`        // The browser context to create the page in.
	EnableBeginFrameControl bool             `json:"enableBeginFrameControl,omitempty"` // Whether BeginFrames for this target will be controlled via DevTools (headless chrome only, not supported on MacOS yet, false by default).
	NewWindow               bool             `json:"newWindow,omitempty"`               // Whether to create a new Window or Tab (chrome-only, false by default).
	Background              bool             `json:"background,omitempty"`              // Whether to create the target in background or foreground (chrome-only, false by default).
}

CreateTargetParams creates a new page.

func CreateTarget

func CreateTarget(url string) *CreateTargetParams

CreateTarget creates a new page.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-createTarget

parameters:

url - The initial URL the page will be navigated to.

func (*CreateTargetParams) Do

func (p *CreateTargetParams) Do(ctx context.Context) (targetID ID, err error)

Do executes Target.createTarget against the provided context.

returns:

targetID - The id of the page opened.

func (CreateTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CreateTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (CreateTargetParams) WithBackground

func (p CreateTargetParams) WithBackground(background bool) *CreateTargetParams

WithBackground whether to create the target in background or foreground (chrome-only, false by default).

func (CreateTargetParams) WithBrowserContextID

func (p CreateTargetParams) WithBrowserContextID(browserContextID BrowserContextID) *CreateTargetParams

WithBrowserContextID the browser context to create the page in.

func (CreateTargetParams) WithEnableBeginFrameControl

func (p CreateTargetParams) WithEnableBeginFrameControl(enableBeginFrameControl bool) *CreateTargetParams

WithEnableBeginFrameControl whether BeginFrames for this target will be controlled via DevTools (headless chrome only, not supported on MacOS yet, false by default).

func (CreateTargetParams) WithHeight

func (p CreateTargetParams) WithHeight(height int64) *CreateTargetParams

WithHeight frame height in DIP (headless chrome only).

func (CreateTargetParams) WithNewWindow

func (p CreateTargetParams) WithNewWindow(newWindow bool) *CreateTargetParams

WithNewWindow whether to create a new Window or Tab (chrome-only, false by default).

func (CreateTargetParams) WithWidth

func (p CreateTargetParams) WithWidth(width int64) *CreateTargetParams

WithWidth frame width in DIP (headless chrome only).

type CreateTargetReturns

type CreateTargetReturns struct {
	TargetID ID `json:"targetId,omitempty"` // The id of the page opened.
}

CreateTargetReturns return values.

func (CreateTargetReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateTargetReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*CreateTargetReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateTargetReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type DetachFromTargetParams

type DetachFromTargetParams struct {
	SessionID SessionID `json:"sessionId,omitempty"` // Session to detach.
}

DetachFromTargetParams detaches session with given id.

func DetachFromTarget

func DetachFromTarget() *DetachFromTargetParams

DetachFromTarget detaches session with given id.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-detachFromTarget

parameters:

func (*DetachFromTargetParams) Do

func (p *DetachFromTargetParams) Do(ctx context.Context) (err error)

Do executes Target.detachFromTarget against the provided context.

func (DetachFromTargetParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (DetachFromTargetParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*DetachFromTargetParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DetachFromTargetParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (DetachFromTargetParams) WithSessionID

func (p DetachFromTargetParams) WithSessionID(sessionID SessionID) *DetachFromTargetParams

WithSessionID session to detach.

type DisposeBrowserContextParams

type DisposeBrowserContextParams struct {
	BrowserContextID BrowserContextID `json:"browserContextId"`
}

DisposeBrowserContextParams deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.

func DisposeBrowserContext

func DisposeBrowserContext(browserContextID BrowserContextID) *DisposeBrowserContextParams

DisposeBrowserContext deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-disposeBrowserContext

parameters:

browserContextID

func (*DisposeBrowserContextParams) Do

Do executes Target.disposeBrowserContext against the provided context.

func (DisposeBrowserContextParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (DisposeBrowserContextParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*DisposeBrowserContextParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DisposeBrowserContextParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventAttachedToTarget

type EventAttachedToTarget struct {
	SessionID          SessionID `json:"sessionId"` // Identifier assigned to the session used to send/receive messages.
	TargetInfo         *Info     `json:"targetInfo"`
	WaitingForDebugger bool      `json:"waitingForDebugger"`
}

EventAttachedToTarget issued when attached to target because of auto-attach or attachToTarget command.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-attachedToTarget

func (EventAttachedToTarget) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventAttachedToTarget) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventAttachedToTarget) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventAttachedToTarget) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventDetachedFromTarget

type EventDetachedFromTarget struct {
	SessionID SessionID `json:"sessionId"` // Detached session identifier.
}

EventDetachedFromTarget issued when detached from target for any reason (including detachFromTarget command). Can be issued multiple times per target if multiple sessions have been attached to it.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-detachedFromTarget

func (EventDetachedFromTarget) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventDetachedFromTarget) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventDetachedFromTarget) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventDetachedFromTarget) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventReceivedMessageFromTarget

type EventReceivedMessageFromTarget struct {
	SessionID SessionID `json:"sessionId"` // Identifier of a session which sends a message.
	Message   string    `json:"message"`
}

EventReceivedMessageFromTarget notifies about a new protocol message received from the session (as reported in attachedToTarget event).

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-receivedMessageFromTarget

func (EventReceivedMessageFromTarget) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventReceivedMessageFromTarget) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventReceivedMessageFromTarget) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventReceivedMessageFromTarget) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventTargetCrashed

type EventTargetCrashed struct {
	TargetID  ID     `json:"targetId"`
	Status    string `json:"status"`    // Termination status type.
	ErrorCode int64  `json:"errorCode"` // Termination error code.
}

EventTargetCrashed issued when a target has crashed.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-targetCrashed

func (EventTargetCrashed) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventTargetCrashed) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventTargetCrashed) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventTargetCrashed) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventTargetCreated

type EventTargetCreated struct {
	TargetInfo *Info `json:"targetInfo"`
}

EventTargetCreated issued when a possible inspection target is created.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-targetCreated

func (EventTargetCreated) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventTargetCreated) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventTargetCreated) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventTargetCreated) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventTargetDestroyed

type EventTargetDestroyed struct {
	TargetID ID `json:"targetId"`
}

EventTargetDestroyed issued when a target is destroyed.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-targetDestroyed

func (EventTargetDestroyed) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventTargetDestroyed) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventTargetDestroyed) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventTargetDestroyed) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type EventTargetInfoChanged

type EventTargetInfoChanged struct {
	TargetInfo *Info `json:"targetInfo"`
}

EventTargetInfoChanged issued when some information about a target has changed. This only happens between targetCreated and targetDestroyed.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#event-targetInfoChanged

func (EventTargetInfoChanged) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventTargetInfoChanged) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*EventTargetInfoChanged) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventTargetInfoChanged) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type ExposeDevToolsProtocolParams

type ExposeDevToolsProtocolParams struct {
	TargetID    ID     `json:"targetId"`
	BindingName string `json:"bindingName,omitempty"` // Binding name, 'cdp' if not specified.
}

ExposeDevToolsProtocolParams inject object to the target's main frame that provides a communication channel with browser target. Injected object will be available as window[bindingName]. The object has the follwing API: - binding.send(json) - a method to send messages over the remote debugging protocol - binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses.

func ExposeDevToolsProtocol

func ExposeDevToolsProtocol(targetID ID) *ExposeDevToolsProtocolParams

ExposeDevToolsProtocol inject object to the target's main frame that provides a communication channel with browser target. Injected object will be available as window[bindingName]. The object has the follwing API: - binding.send(json) - a method to send messages over the remote debugging protocol - binding.onmessage = json => handleMessage(json) - a callback that will be called for the protocol notifications and command responses.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-exposeDevToolsProtocol

parameters:

targetID

func (*ExposeDevToolsProtocolParams) Do

Do executes Target.exposeDevToolsProtocol against the provided context.

func (ExposeDevToolsProtocolParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (ExposeDevToolsProtocolParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*ExposeDevToolsProtocolParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*ExposeDevToolsProtocolParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (ExposeDevToolsProtocolParams) WithBindingName

func (p ExposeDevToolsProtocolParams) WithBindingName(bindingName string) *ExposeDevToolsProtocolParams

WithBindingName binding name, 'cdp' if not specified.

type GetBrowserContextsParams

type GetBrowserContextsParams struct{}

GetBrowserContextsParams returns all browser contexts created with Target.createBrowserContext method.

func GetBrowserContexts

func GetBrowserContexts() *GetBrowserContextsParams

GetBrowserContexts returns all browser contexts created with Target.createBrowserContext method.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-getBrowserContexts

func (*GetBrowserContextsParams) Do

func (p *GetBrowserContextsParams) Do(ctx context.Context) (browserContextIds []BrowserContextID, err error)

Do executes Target.getBrowserContexts against the provided context.

returns:

browserContextIds - An array of browser context ids.

func (GetBrowserContextsParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetBrowserContextsParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetBrowserContextsParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetBrowserContextsParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type GetBrowserContextsReturns

type GetBrowserContextsReturns struct {
	BrowserContextIds []BrowserContextID `json:"browserContextIds,omitempty"` // An array of browser context ids.
}

GetBrowserContextsReturns return values.

func (GetBrowserContextsReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetBrowserContextsReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetBrowserContextsReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetBrowserContextsReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type GetTargetInfoParams

type GetTargetInfoParams struct {
	TargetID ID `json:"targetId,omitempty"`
}

GetTargetInfoParams returns information about a target.

func GetTargetInfo

func GetTargetInfo() *GetTargetInfoParams

GetTargetInfo returns information about a target.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-getTargetInfo

parameters:

func (*GetTargetInfoParams) Do

func (p *GetTargetInfoParams) Do(ctx context.Context) (targetInfo *Info, err error)

Do executes Target.getTargetInfo against the provided context.

returns:

targetInfo

func (GetTargetInfoParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetTargetInfoParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetTargetInfoParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetTargetInfoParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (GetTargetInfoParams) WithTargetID

func (p GetTargetInfoParams) WithTargetID(targetID ID) *GetTargetInfoParams

WithTargetID [no description].

type GetTargetInfoReturns

type GetTargetInfoReturns struct {
	TargetInfo *Info `json:"targetInfo,omitempty"`
}

GetTargetInfoReturns return values.

func (GetTargetInfoReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetTargetInfoReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetTargetInfoReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetTargetInfoReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type GetTargetsParams

type GetTargetsParams struct{}

GetTargetsParams retrieves a list of available targets.

func GetTargets

func GetTargets() *GetTargetsParams

GetTargets retrieves a list of available targets.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-getTargets

func (*GetTargetsParams) Do

func (p *GetTargetsParams) Do(ctx context.Context) (targetInfos []*Info, err error)

Do executes Target.getTargets against the provided context.

returns:

targetInfos - The list of targets.

func (GetTargetsParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetTargetsParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetTargetsParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetTargetsParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type GetTargetsReturns

type GetTargetsReturns struct {
	TargetInfos []*Info `json:"targetInfos,omitempty"` // The list of targets.
}

GetTargetsReturns return values.

func (GetTargetsReturns) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetTargetsReturns) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*GetTargetsReturns) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetTargetsReturns) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type ID

type ID string

ID [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#type-TargetID

func (ID) String

func (t ID) String() string

String returns the ID as string value.

type Info

type Info struct {
	TargetID         ID               `json:"targetId"`
	Type             string           `json:"type"`
	Title            string           `json:"title"`
	URL              string           `json:"url"`
	Attached         bool             `json:"attached"`           // Whether the target has an attached client.
	OpenerID         ID               `json:"openerId,omitempty"` // Opener target Id
	BrowserContextID BrowserContextID `json:"browserContextId,omitempty"`
}

Info [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#type-TargetInfo

func (Info) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Info) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*Info) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Info) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type RemoteLocation

type RemoteLocation struct {
	Host string `json:"host"`
	Port int64  `json:"port"`
}

RemoteLocation [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#type-RemoteLocation

func (RemoteLocation) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (RemoteLocation) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*RemoteLocation) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RemoteLocation) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type SessionID

type SessionID string

SessionID unique identifier of attached debugging session.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#type-SessionID

func (SessionID) String

func (t SessionID) String() string

String returns the SessionID as string value.

type SetAutoAttachParams

type SetAutoAttachParams struct {
	AutoAttach             bool `json:"autoAttach"`             // Whether to auto-attach to related targets.
	WaitForDebuggerOnStart bool `json:"waitForDebuggerOnStart"` // Whether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger to run paused targets.
	Flatten                bool `json:"flatten,omitempty"`      // Enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.
	WindowOpen             bool `json:"windowOpen,omitempty"`   // Auto-attach to the targets created via window.open from current target.
}

SetAutoAttachParams controls whether to automatically attach to new targets which are considered to be related to this one. When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets.

func SetAutoAttach

func SetAutoAttach(autoAttach bool, waitForDebuggerOnStart bool) *SetAutoAttachParams

SetAutoAttach controls whether to automatically attach to new targets which are considered to be related to this one. When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-setAutoAttach

parameters:

autoAttach - Whether to auto-attach to related targets.
waitForDebuggerOnStart - Whether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger to run paused targets.

func (*SetAutoAttachParams) Do

func (p *SetAutoAttachParams) Do(ctx context.Context) (err error)

Do executes Target.setAutoAttach against the provided context.

func (SetAutoAttachParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetAutoAttachParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*SetAutoAttachParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetAutoAttachParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

func (SetAutoAttachParams) WithFlatten

func (p SetAutoAttachParams) WithFlatten(flatten bool) *SetAutoAttachParams

WithFlatten enables "flat" access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.

func (SetAutoAttachParams) WithWindowOpen

func (p SetAutoAttachParams) WithWindowOpen(windowOpen bool) *SetAutoAttachParams

WithWindowOpen auto-attach to the targets created via window.open from current target.

type SetDiscoverTargetsParams

type SetDiscoverTargetsParams struct {
	Discover bool `json:"discover"` // Whether to discover available targets.
}

SetDiscoverTargetsParams controls whether to discover available targets and notify via targetCreated/targetInfoChanged/targetDestroyed events.

func SetDiscoverTargets

func SetDiscoverTargets(discover bool) *SetDiscoverTargetsParams

SetDiscoverTargets controls whether to discover available targets and notify via targetCreated/targetInfoChanged/targetDestroyed events.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-setDiscoverTargets

parameters:

discover - Whether to discover available targets.

func (*SetDiscoverTargetsParams) Do

func (p *SetDiscoverTargetsParams) Do(ctx context.Context) (err error)

Do executes Target.setDiscoverTargets against the provided context.

func (SetDiscoverTargetsParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetDiscoverTargetsParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*SetDiscoverTargetsParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetDiscoverTargetsParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

type SetRemoteLocationsParams

type SetRemoteLocationsParams struct {
	Locations []*RemoteLocation `json:"locations"` // List of remote locations.
}

SetRemoteLocationsParams enables target discovery for the specified locations, when setDiscoverTargets was set to true.

func SetRemoteLocations

func SetRemoteLocations(locations []*RemoteLocation) *SetRemoteLocationsParams

SetRemoteLocations enables target discovery for the specified locations, when setDiscoverTargets was set to true.

See: https://chromedevtools.github.io/devtools-protocol/tot/Target#method-setRemoteLocations

parameters:

locations - List of remote locations.

func (*SetRemoteLocationsParams) Do

func (p *SetRemoteLocationsParams) Do(ctx context.Context) (err error)

Do executes Target.setRemoteLocations against the provided context.

func (SetRemoteLocationsParams) MarshalEasyJSON

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetRemoteLocationsParams) MarshalJSON

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

MarshalJSON supports json.Marshaler interface

func (*SetRemoteLocationsParams) UnmarshalEasyJSON

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetRemoteLocationsParams) UnmarshalJSON

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

UnmarshalJSON supports json.Unmarshaler interface

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL