Liking cljdoc? Tell your friends :D

clj-chrome-devtools.commands.target

Supports additional targets discovery and allows to attach to them.

Supports additional targets discovery and allows to attach to them.
raw docstring

activate-targetclj

(activate-target)
(activate-target {:as params :keys [target-id]})
(activate-target connection {:as params :keys [target-id]})

Activates (focuses) the target.

Parameters map keys:

KeyDescription
:target-idnull
Activates (focuses) the target.

Parameters map keys:


  Key        | Description 
  -----------|------------ 
  :target-id | null
sourceraw docstring

attach-to-targetclj

(attach-to-target)
(attach-to-target {:as params :keys [target-id]})
(attach-to-target connection {:as params :keys [target-id]})

Attaches to the target with given id.

Parameters map keys:

KeyDescription
:target-idnull

Return map keys:

KeyDescription
:session-idId assigned to the session.
Attaches to the target with given id.

Parameters map keys:


  Key        | Description 
  -----------|------------ 
  :target-id | null

Return map keys:


  Key         | Description 
  ------------|------------ 
  :session-id | Id assigned to the session.
sourceraw docstring

close-targetclj

(close-target)
(close-target {:as params :keys [target-id]})
(close-target connection {:as params :keys [target-id]})

Closes the target. If the target is a page that gets closed too.

Parameters map keys:

KeyDescription
:target-idnull

Return map keys:

KeyDescription
:successnull
Closes the target. If the target is a page that gets closed too.

Parameters map keys:


  Key        | Description 
  -----------|------------ 
  :target-id | null

Return map keys:


  Key      | Description 
  ---------|------------ 
  :success | null
sourceraw docstring

create-browser-contextclj

(create-browser-context)
(create-browser-context {:as params :keys []})
(create-browser-context connection {:as params :keys []})

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

Return map keys:

KeyDescription
:browser-context-idThe id of the context created.
Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

Return map keys:


  Key                 | Description 
  --------------------|------------ 
  :browser-context-id | The id of the context created.
sourceraw docstring

create-targetclj

(create-target)
(create-target {:as params :keys [url width height browser-context-id]})
(create-target connection
               {:as params :keys [url width height browser-context-id]})

Creates a new page.

Parameters map keys:

KeyDescription
:urlThe initial URL the page will be navigated to.
:widthFrame width in DIP (headless chrome only). (optional)
:heightFrame height in DIP (headless chrome only). (optional)
:browser-context-idThe browser context to create the page in (headless chrome only). (optional)

Return map keys:

KeyDescription
:target-idThe id of the page opened.
Creates a new page.

Parameters map keys:


  Key                 | Description 
  --------------------|------------ 
  :url                | The initial URL the page will be navigated to.
  :width              | Frame width in DIP (headless chrome only). (optional)
  :height             | Frame height in DIP (headless chrome only). (optional)
  :browser-context-id | The browser context to create the page in (headless chrome only). (optional)

Return map keys:


  Key        | Description 
  -----------|------------ 
  :target-id | The id of the page opened.
sourceraw docstring

detach-from-targetclj

(detach-from-target)
(detach-from-target {:as params :keys [session-id target-id]})
(detach-from-target connection {:as params :keys [session-id target-id]})

Detaches session with given id.

Parameters map keys:

KeyDescription
:session-idSession to detach. (optional)
:target-idDeprecated. (optional)
Detaches session with given id.

Parameters map keys:


  Key         | Description 
  ------------|------------ 
  :session-id | Session to detach. (optional)
  :target-id  | Deprecated. (optional)
sourceraw docstring

dispose-browser-contextclj

(dispose-browser-context)
(dispose-browser-context {:as params :keys [browser-context-id]})
(dispose-browser-context connection {:as params :keys [browser-context-id]})

Deletes a BrowserContext, will fail of any open page uses it.

Parameters map keys:

KeyDescription
:browser-context-idnull

Return map keys:

KeyDescription
:successnull
Deletes a BrowserContext, will fail of any open page uses it.

Parameters map keys:


  Key                 | Description 
  --------------------|------------ 
  :browser-context-id | null

Return map keys:


  Key      | Description 
  ---------|------------ 
  :success | null
sourceraw docstring

get-target-infoclj

(get-target-info)
(get-target-info {:as params :keys [target-id]})
(get-target-info connection {:as params :keys [target-id]})

Returns information about a target.

Parameters map keys:

KeyDescription
:target-idnull

Return map keys:

KeyDescription
:target-infonull
Returns information about a target.

Parameters map keys:


  Key        | Description 
  -----------|------------ 
  :target-id | null

Return map keys:


  Key          | Description 
  -------------|------------ 
  :target-info | null
sourceraw docstring

get-targetsclj

(get-targets)
(get-targets {:as params :keys []})
(get-targets connection {:as params :keys []})

Retrieves a list of available targets.

Return map keys:

KeyDescription
:target-infosThe list of targets.
Retrieves a list of available targets.

Return map keys:


  Key           | Description 
  --------------|------------ 
  :target-infos | The list of targets.
sourceraw docstring

send-message-to-targetclj

(send-message-to-target)
(send-message-to-target {:as params :keys [message session-id target-id]})
(send-message-to-target connection
                        {:as params :keys [message session-id target-id]})

Sends protocol message over session with given id.

Parameters map keys:

KeyDescription
:messagenull
:session-idIdentifier of the session. (optional)
:target-idDeprecated. (optional)
Sends protocol message over session with given id.

Parameters map keys:


  Key         | Description 
  ------------|------------ 
  :message    | null
  :session-id | Identifier of the session. (optional)
  :target-id  | Deprecated. (optional)
sourceraw docstring

set-attach-to-framesclj

(set-attach-to-frames)
(set-attach-to-frames {:as params :keys [value]})
(set-attach-to-frames connection {:as params :keys [value]})

Parameters map keys:

KeyDescription
:valueWhether to attach to frames.

Parameters map keys:


  Key    | Description 
  -------|------------ 
  :value | Whether to attach to frames.
sourceraw docstring

set-auto-attachclj

(set-auto-attach)
(set-auto-attach {:as params :keys [auto-attach wait-for-debugger-on-start]})
(set-auto-attach connection
                 {:as params :keys [auto-attach wait-for-debugger-on-start]})

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.

Parameters map keys:

KeyDescription
:auto-attachWhether to auto-attach to related targets.
:wait-for-debugger-on-startWhether to pause new targets when attaching to them. Use Runtime.runIfWaitingForDebugger to run paused targets.
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.

Parameters map keys:


  Key                         | Description 
  ----------------------------|------------ 
  :auto-attach                | Whether to auto-attach to related targets.
  :wait-for-debugger-on-start | Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger` to run paused targets.
sourceraw docstring

set-discover-targetsclj

(set-discover-targets)
(set-discover-targets {:as params :keys [discover]})
(set-discover-targets connection {:as params :keys [discover]})

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

Parameters map keys:

KeyDescription
:discoverWhether to discover available targets.
Controls whether to discover available targets and notify via `targetCreated/targetInfoChanged/targetDestroyed` events.

Parameters map keys:


  Key       | Description 
  ----------|------------ 
  :discover | Whether to discover available targets.
sourceraw docstring

set-remote-locationsclj

(set-remote-locations)
(set-remote-locations {:as params :keys [locations]})
(set-remote-locations connection {:as params :keys [locations]})

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

Parameters map keys:

KeyDescription
:locationsList of remote locations.
Enables target discovery for the specified locations, when `setDiscoverTargets` was set to `true`.

Parameters map keys:


  Key        | Description 
  -----------|------------ 
  :locations | List of remote locations.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close