CdpBrowser (jvppeteer 3.4.0 API)

java.lang.Object
- com.ruiyun.jvppeteer.api.core.EventEmitter<BrowserEvents>
- - com.ruiyun.jvppeteer.api.core.Browser
  - - com.ruiyun.jvppeteer.cdp.core.CdpBrowser

所有已实现的接口:

AutoCloseable
```
public class CdpBrowser
extends Browser
```
Browser 代表一个浏览器实例，它是：
通过 Puppeteer.connect() 连接到或 - 由 Puppeteer.launch() 产生。
Browser emits 各种事件记录在 BrowserEvent 枚举中。
第三方代码不应直接调用构造函数或创建扩展 Browser 类的子类。

字段概要
- 从类继承的字段 com.ruiyun.jvppeteer.api.core.Browser
  autoClose

构造器概要

构造器
限定符	构造器和说明
`protected`	`CdpBrowser(Connection connection, List<String> contextIds, Viewport viewport, Process process, Runnable closeCallback, Function<Target,Boolean> targetFilterCallback, Function<Target,Boolean> isPageTargetCallback, boolean waitForInitiallyDiscoveredTargets, boolean networkEnabled)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`List<BrowserContext>`	`browserContexts()` 获取打开的浏览器上下文列表。
`void`	`cancelDownload(String guid, String browserContextId)` 设置下载行为
`void`	`close()`
`boolean`	`connected()` Jvppeteer 是否连接到此 browser。
`static CdpBrowser`	`create(Connection connection, List<String> contextIds, boolean acceptInsecureCerts, Viewport defaultViewport, Process process, Runnable closeCallback, Function<Target,Boolean> targetFilterCallback, Function<Target,Boolean> IsPageTargetCallback, boolean waitForInitiallyDiscoveredTargets, boolean networkEnabled)`
`CdpBrowserContext`	`createBrowserContext(BrowserContextOptions options)` 创建一个新的浏览器上下文。
`DebugInfo`	`debugInfo()` 从 Jvppeteer 获取 debug 信息目前，信息包括待处理的协议调用。
`List<String>`	`defaultArgs()` 返回默认的运行的参数
`CdpBrowserContext`	`defaultBrowserContext()` 获取默认浏览器上下文。
`void`	`disconnect()` 断开 Jvppeteer 与该 browser 的连接，但保持进程运行。
`String`	`executablePath()` 返回浏览器的可执行路径。
`boolean`	`isNetworkEnabled()`
`Page`	`newPage()` 在默认浏览器上下文中创建新的 page。
`Process`	`process()` 获取关联的 Process。
`void`	`setDefaultArgs(List<String> defaultArgs)`
`void`	`setDownloadBehavior(DownloadOptions options)` 设置下载行为
`void`	`setExecutablePath(String executablePath)`
`Target`	`target()` 获取与默认浏览器上下文关联的 target。
`TargetManager`	`targetManager()`
`List<CdpTarget>`	`targets()` 获取所有活动的 targets。
`String`	`userAgent()` 获取此浏览器的原始用户代理。
`String`	`version()` 获取表示此浏览器的名称和版本的字符串。
`String`	`wsEndpoint()` 获取用于连接到此 browser 的 WebSocket URL。

从类继承的方法 com.ruiyun.jvppeteer.api.core.Browser
cookies, createBrowserContext, disposeSymbol, pages, setCookie, waitForTarget, waitForTarget

从类继承的方法 com.ruiyun.jvppeteer.api.core.EventEmitter
emit, listenerCount, off, on, once, removeAllListeners, removeListener

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CdpBrowser
```
protected CdpBrowser(Connection connection,
                     List<String> contextIds,
                     Viewport viewport,
                     Process process,
                     Runnable closeCallback,
                     Function<Target,Boolean> targetFilterCallback,
                     Function<Target,Boolean> isPageTargetCallback,
                     boolean waitForInitiallyDiscoveredTargets,
                     boolean networkEnabled)
```
- 方法详细资料
  - process
```
public Process process()
```
    获取关联的 Process。
    
    指定者:
    
    process 在类中 Browser
    
    返回:
    
    浏览器进程对象
  - executablePath
```
public String executablePath()
```
    返回浏览器的可执行路径。
    
    返回:
    
    可执行路径
  - targetManager
```
public TargetManager targetManager()
```
  - createBrowserContext
```
public CdpBrowserContext createBrowserContext(BrowserContextOptions options)
```
    从类复制的说明: Browser
    
    创建一个新的浏览器上下文。
    这不会与其他浏览器上下文共享 cookie/缓存
    
    指定者:
    
    createBrowserContext 在类中 Browser
    
    参数:
    
    options - 浏览器上下文选项，包含代理服务器设置等
    
    返回:
    
    返回创建的浏览器上下文对象
  - browserContexts
```
public List<BrowserContext> browserContexts()
```
    从类复制的说明: Browser
    
    获取打开的浏览器上下文列表。
    在新创建的 browser 中，这将返回 BrowserContext 的单个实例。
    
    指定者:
    
    browserContexts 在类中 Browser
    
    返回:
    
    打开的浏览器上下文列表
  - defaultBrowserContext
```
public CdpBrowserContext defaultBrowserContext()
```
    从类复制的说明: Browser
    
    获取默认浏览器上下文。
    默认浏览器上下文无法关闭。
    
    指定者:
    
    defaultBrowserContext 在类中 Browser
    
    返回:
    
    默认浏览器上下文
  - wsEndpoint
```
public String wsEndpoint()
```
    从类复制的说明: Browser
    
    获取用于连接到此 browser 的 WebSocket URL。
    这通常与 Puppeteer.connect() 一起使用。
    你可以从 http://HOST:PORT/json/version 找到调试器 URL (webSocketDebuggerUrl)。
    请参阅浏览器端点了解更多信息。
    
    指定者:
    
    wsEndpoint 在类中 Browser
    
    返回:
    
    WebSocket URL
  - newPage
```
public Page newPage()
```
    从类复制的说明: Browser
    
    在默认浏览器上下文中创建新的 page。
    
    指定者:
    
    newPage 在类中 Browser
    
    返回:
    
    新创建的页面对象
  - target
```
public Target target()
```
    从类复制的说明: Browser
    
    获取与默认浏览器上下文关联的 target。
    
    指定者:
    
    target 在类中 Browser
    
    返回:
    
    默认浏览器上下文关联的 target
  - targets
```
public List<CdpTarget> targets()
```
    从类复制的说明: Browser
    
    获取所有活动的 targets。
    如果有多个浏览器上下文，则返回所有浏览器上下文中的所有 targets。
    
    指定者:
    
    targets 在类中 Browser
    
    返回:
    
    所有活动的 targets
  - version
```
public String version()
               throws com.fasterxml.jackson.core.JsonProcessingException
```
    从类复制的说明: Browser
    
    获取表示此浏览器的名称和版本的字符串。
    对于无头浏览器，这与 "HeadlessChrome/61.0.3153.0" 类似。对于非无头或新无头，这与 "Chrome/61.0.3153.0" 类似。
    对于火狐浏览器，这与 "Firefox/116.0a1"类似
    Browser.version() 的格式可能会随着浏览器的未来版本而改变。
    
    指定者:
    
    version 在类中 Browser
    
    返回:
    
    浏览器版本
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException - 序列化错误
  - userAgent
```
public String userAgent()
```
    从类复制的说明: Browser
    
    获取此浏览器的原始用户代理。
    Pages 可以使用 Page.setUserAgent() 覆盖用户代理。e
    
    指定者:
    
    userAgent 在类中 Browser
    
    返回:
    
    原始用户代理
  - close
```
public void close()
```
  - disconnect
```
public void disconnect()
```
    从类复制的说明: Browser
    
    断开 Jvppeteer 与该 browser 的连接，但保持进程运行。
    
    指定者:
    
    disconnect 在类中 Browser
  - connected
```
public boolean connected()
```
    从类复制的说明: Browser
    
    Jvppeteer 是否连接到此 browser。
    
    指定者:
    
    connected 在类中 Browser
    
    返回:
    
    连接返回true, 不连接返回false
  - debugInfo
```
public DebugInfo debugInfo()
```
    从类复制的说明: Browser
    
    从 Jvppeteer 获取 debug 信息
    目前，信息包括待处理的协议调用。将来，我们可能会添加更多信息。
    
    指定者:
    
    debugInfo 在类中 Browser
    
    返回:
    
    debug 信息
  - create
```
public static CdpBrowser create(Connection connection,
                                List<String> contextIds,
                                boolean acceptInsecureCerts,
                                Viewport defaultViewport,
                                Process process,
                                Runnable closeCallback,
                                Function<Target,Boolean> targetFilterCallback,
                                Function<Target,Boolean> IsPageTargetCallback,
                                boolean waitForInitiallyDiscoveredTargets,
                                boolean networkEnabled)
```
  - setExecutablePath
```
public void setExecutablePath(String executablePath)
```
  - defaultArgs
```
public List<String> defaultArgs()
```
    返回默认的运行的参数
    
    返回:
    
    默认参数集合
  - setDefaultArgs
```
public void setDefaultArgs(List<String> defaultArgs)
```
  - setDownloadBehavior
```
public void setDownloadBehavior(DownloadOptions options)
```
    设置下载行为
    
    指定者:
    
    setDownloadBehavior 在类中 Browser
    
    参数:
    
    options - 可选配置，可以设置下载的存放路径，是否接受下载事件，拒绝还是接受下载如果没有指定 browserContextId,则设置默认浏览器上下文的下载行为
  - cancelDownload
```
public void cancelDownload(String guid,
                           String browserContextId)
```
    设置下载行为
    
    指定者:
    
    cancelDownload 在类中 Browser
    
    参数:
    
    guid - 下载的全局唯一标识符。
    
    browserContextId - BrowserContext 在其中执行操作。省略时，将使用默认浏览器上下文。
  - isNetworkEnabled
```
public boolean isNetworkEnabled()
```
    指定者:
    
    isNetworkEnabled 在类中 Browser

类 CdpBrowser

字段概要

从类继承的字段 com.ruiyun.jvppeteer.api.core.Browser

构造器概要

方法概要

从类继承的方法 com.ruiyun.jvppeteer.api.core.Browser

从类继承的方法 com.ruiyun.jvppeteer.api.core.EventEmitter

从类继承的方法 java.lang.Object

构造器详细资料

CdpBrowser

方法详细资料

process

executablePath

targetManager

createBrowserContext

browserContexts

defaultBrowserContext

wsEndpoint

newPage

target

targets

version

userAgent

close

disconnect

connected

debugInfo

create

setExecutablePath

defaultArgs

setDefaultArgs

setDownloadBehavior

cancelDownload

isNetworkEnabled