Package io.testproject.sdk.internal.rest.messages

Class DriverCommandReport

java.lang.Object

io.testproject.sdk.internal.rest.messages.Report

io.testproject.sdk.internal.rest.messages.DriverCommandReport

public final class DriverCommandReport
extends Report

Payload object sent to the Agent when reporting a driver command.

Constructor Summary

Constructors

Constructor	Description
DriverCommandReport(java.lang.String commandName, java.util.Map<java.lang.String,?> commandParameters, java.lang.Object result, boolean passed)	Creates a new instance using provided commandName, result and boolean success/failure flag.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommandName()	Getter for commandName field.
java.util.Map<java.lang.String,?>	getCommandParameters()	Getter for commandParameters field.
java.lang.Object	getResult()	Getter for result field.
java.lang.String	getScreenshot()	Getter for screenshot field.
boolean	isPassed()	Getter for passed field.
void	setScreenshot(java.lang.String screenshot)	Setter for screenshot field.
java.lang.String	toString()	String representation of the class fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DriverCommandReport

public DriverCommandReport(java.lang.String commandName,
                           java.util.Map<java.lang.String,?> commandParameters,
                           java.lang.Object result,
                           boolean passed)

Creates a new instance using provided commandName, result and boolean success/failure flag.

Parameters:

commandName - Name of the commandName executed by the driver.

commandParameters - Executed commandName commandParameters.

result - Command result formatted as String

passed - Boolean flag to indicate commandName successful execution or failure.

Method Detail

getScreenshot

public java.lang.String getScreenshot()

Getter for screenshot field.

Returns:

value of screenshot field

setScreenshot

public void setScreenshot(java.lang.String screenshot)

Setter for screenshot field.

Parameters:

screenshot - Screenshot (as base64 string) to be set.

getCommandName

public java.lang.String getCommandName()

Getter for commandName field.

Returns:

value of commandName field

getCommandParameters

public java.util.Map<java.lang.String,?> getCommandParameters()

Getter for commandParameters field.

Returns:

value of commandParameters field

getResult

public java.lang.Object getResult()

Getter for result field.

Returns:

value of result field

isPassed

public boolean isPassed()

Getter for passed field.

Returns:

value of passed field

toString

public java.lang.String toString()

String representation of the class fields.

Overrides:

toString in class java.lang.Object

Returns:

String based on commandName.