parikshan-core/io.github.aryapreetam.parikshan.protocol/Command

Command

@Serializable

sealed class Command

Inheritors

Types

@Serializable

@SerialName(value = "assert_text")

data class AssertText(val id: String, val tag: String, val expected: String, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

@Serializable

@SerialName(value = "assert_visible")

data class AssertVisible(val id: String, val tag: String, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

@Serializable

@SerialName(value = "click")

data class Click(val id: String, val tag: String, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

@Serializable

@SerialName(value = "gettree")

data class GetTree(val id: String, var token: String = "") : Command

interface HasSelector

Implemented by commands that target a UI element.

@Serializable

@SerialName(value = "input")

data class Input(val id: String, val tag: String, val text: String, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

@Serializable

@SerialName(value = "ping")

data class Ping(val id: String, var token: String = "") : Command

@Serializable

@SerialName(value = "pressback")

data class PressBack(val id: String, var token: String = "") : Command

@Serializable

@SerialName(value = "presshome")

data class PressHome(val id: String, var token: String = "") : Command

@Serializable

@SerialName(value = "relaunchapp")

data class RelaunchApp(val id: String, var token: String = "") : Command

@Serializable

@SerialName(value = "screenshot")

data class Screenshot(val id: String, val devicePath: String, val hostPath: String, var token: String = "") : Command

@Serializable

@SerialName(value = "scroll")

data class Scroll(val id: String, val tag: String, val direction: ScrollDirection, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

@Serializable

@SerialName(value = "shutdown")

data class Shutdown(val id: String, var token: String = "") : Command

@Serializable

@SerialName(value = "startrecording")

data class StartRecording(val id: String, val sessionName: String, val path: String, val fps: Int = 1, val showCursor: Boolean = true, var token: String = "") : Command

@Serializable

@SerialName(value = "stoprecording")

data class StopRecording(val id: String, val sessionName: String, var token: String = "") : Command

@Serializable

@SerialName(value = "waitfor")

data class WaitFor(val id: String, val tag: String, val timeoutMs: Long = 10000, val selector: Selector? = null, var token: String = "") : Command, Command.HasSelector

Properties

abstract val id: String

abstract var token: String

Functions

resolvedSelector

fun Command.resolvedSelector(): Selector?

Resolves the effective Selector from a Command. If the command implements Command.HasSelector, returns the explicit selector or falls back to Selector.Auto wrapping Command.HasSelector.tag. Returns null for commands that don't target a UI element (e.g., Ping, GetTree).