pl.wendigo.chrome.domain.domsnapshot.DOMSnapshotDomain.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chrome-reactive-kotlin Show documentation

Chrome Reactive - low level, remote chrome debugger protocol client (DevTools)

There is a newer version: 0.7.4

Show newest version

package pl.wendigo.chrome.domain.domsnapshot

/**
 * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
 */
class DOMSnapshotDomain internal constructor(private val connectionRemote : pl.wendigo.chrome.DebuggerProtocol) {
    /**
     * Returns a document snapshot, including the full DOM tree of the root node (including iframes,
template contents, and imported documents) in a flattened array, as well as layout and
white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
flattened.
     */
    fun getSnapshot(input : GetSnapshotRequest) : io.reactivex.Single {
        return connectionRemote.runAndCaptureResponse("DOMSnapshot.getSnapshot", input, GetSnapshotResponse::class.java).map {
            it.value()
        }
    }

    /**
     * Returns flowable capturing all DOMSnapshot domains events.
     */
    fun events() : io.reactivex.Flowable {
        return connectionRemote.captureAllEvents().map { it.value() }.filter {
            it.protocolDomain() == "DOMSnapshot"
        }
    }
}
/**
 * Represents request frame that can be used with DOMSnapshot.getSnapshot method call.
 *
 * Returns a document snapshot, including the full DOM tree of the root node (including iframes,
template contents, and imported documents) in a flattened array, as well as layout and
white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
flattened.
 */
data class GetSnapshotRequest (
    /**
     * Whitelist of computed styles to return.
     */
    val computedStyleWhitelist : List

)

/**
 * Represents response frame for DOMSnapshot.getSnapshot method call.
 *
 * Returns a document snapshot, including the full DOM tree of the root node (including iframes,
template contents, and imported documents) in a flattened array, as well as layout and
white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
flattened.
 */
data class GetSnapshotResponse(
  /**
   * The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
   */
  val domNodes : List,

  /**
   * The nodes in the layout tree.
   */
  val layoutTreeNodes : List,

  /**
   * Whitelisted ComputedStyle properties for each node in the layout tree.
   */
  val computedStyles : List

)