pl.wendigo.chrome.domain.console.ConsoleDomain.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.console

/**
 * This domain is deprecated - use Runtime or Log instead.
 */
class ConsoleDomain internal constructor(private val connectionRemote : pl.wendigo.chrome.DebuggerProtocol) {
    /**
     * Enables console domain, sends the messages collected so far to the client by means of the messageAdded notification.
     */
    fun enable() : io.reactivex.Single {
        return connectionRemote.runAndCaptureResponse("Console.enable", null, pl.wendigo.chrome.ResponseFrame::class.java).map {
            it.value()
        }
    }

    /**
     * Disables console domain, prevents further console messages from being reported to the client.
     */
    fun disable() : io.reactivex.Single {
        return connectionRemote.runAndCaptureResponse("Console.disable", null, pl.wendigo.chrome.ResponseFrame::class.java).map {
            it.value()
        }
    }

    /**
     * Does nothing.
     */
    fun clearMessages() : io.reactivex.Single {
        return connectionRemote.runAndCaptureResponse("Console.clearMessages", null, pl.wendigo.chrome.ResponseFrame::class.java).map {
            it.value()
        }
    }

    /**
     * Issued when new console message is added.
     */
    fun messageAdded() : io.reactivex.Flowable {
        return messageAddedTimed().map {
            it.value()
        }
    }

    /**
     * Issued when new console message is added.
     */
    fun messageAddedTimed() : io.reactivex.Flowable> {
        return connectionRemote.captureEvents("Console.messageAdded", MessageAddedEvent::class.java)
    }

    /**
     * Returns flowable capturing all Console domains events.
     */
    fun events() : io.reactivex.Flowable {
        return connectionRemote.captureAllEvents().map { it.value() }.filter {
            it.protocolDomain() == "Console"
        }
    }
}

/**
 * Represents event frames for Console.messageAdded
 *
 * Issued when new console message is added.
 */
data class MessageAddedEvent(
  /**
   * Console message that has been added.
   */
  val message : ConsoleMessage

) : pl.wendigo.chrome.ProtocolEvent(domain = "Console", name = "messageAdded")