org.testobject.api

Interface TestObjectClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

TestObjectClientImpl

public interface TestObjectClient
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TestObjectClient.Factory

Method Summary

Modifier and Type	Method and Description
void	close()
List<String>	getAvailableDeviceDescriptorIds()
List<DeviceDescriptor>	getAvailableDeviceDescriptors()
PaginationObject<SessionReport>	getSessionReports(String userId, long offset, int limit, int lastDays, String apiKey)
AppiumTestReport	getTestReport(long reportId, String apiKey)
String	readJunitReport(String apiKey, List<Long> testReportIds)
String	readJunitReport(String apiKey, long testReportId)
String	readTestSuiteXMLReport(long suiteReportId, String apiKey)
File	saveScreenRecording(String videoId, String apiKey, File savePath)
StartInstrumentationResponse	startAndroidSuite(String apiKey, DynamicInstrumentationRequestData requestData)
StartInstrumentationResponse	startAndroidSuite(String apiKey, StaticInstrumentationRequestData requestData)
long	startInstrumentationTestSuite(long suiteId, String apiKey)
StartInstrumentationResponse	startXcuiTestSuite(String apiKey, DynamicInstrumentationRequestData requestData)
StartInstrumentationResponse	startXcuiTestSuite(String apiKey, StaticInstrumentationRequestData requestData)
void	updateInstrumentationTestSuite(long suiteId, File appApk, File instrumentationApk, ApiBatchResource.InstrumentationTestSuiteRequest request, String apiKey)
long	uploadAppApk(String apiKey, File apk)
long	uploadAppIpa(String apiKey, File ipa)
String	uploadFile(String apiKey, File apk)
long	uploadRunnerApk(String apiKey, File apk)
long	uploadRunnerIpa(String apiKey, File ipa)
InstrumentationReport	waitForInstrumentationReport(String apiKey, long testSuiteReportId, long waitTimeoutMs, long sleepTimeMs)
TestSuiteReport	waitForSuiteReport(long suiteReportId, long waitTimeoutMs, long sleepTimeMs, String apiKey)
TestSuiteReport	waitForSuiteReport(long suiteReportId, String apiKey)

Method Detail

waitForSuiteReport

TestSuiteReport waitForSuiteReport(long suiteReportId,
                                   long waitTimeoutMs,
                                   long sleepTimeMs,
                                   String apiKey)

waitForSuiteReport

TestSuiteReport waitForSuiteReport(long suiteReportId,
                                   String apiKey)

readTestSuiteXMLReport

String readTestSuiteXMLReport(long suiteReportId,
                              String apiKey)

startInstrumentationTestSuite

long startInstrumentationTestSuite(long suiteId,
                                   String apiKey)

updateInstrumentationTestSuite

void updateInstrumentationTestSuite(long suiteId,
                                    File appApk,
                                    File instrumentationApk,
                                    ApiBatchResource.InstrumentationTestSuiteRequest request,
                                    String apiKey)

getTestReport

AppiumTestReport getTestReport(long reportId,
                               String apiKey)

uploadFile

String uploadFile(String apiKey,
                  File apk)

saveScreenRecording

File saveScreenRecording(String videoId,
                         String apiKey,
                         File savePath)

uploadRunnerIpa

long uploadRunnerIpa(String apiKey,
                     File ipa)
              throws InvalidUserInputServerException

Throws:

InvalidUserInputServerException

uploadAppIpa

long uploadAppIpa(String apiKey,
                  File ipa)
           throws InvalidUserInputServerException

Throws:

InvalidUserInputServerException

uploadRunnerApk

long uploadRunnerApk(String apiKey,
                     File apk)
              throws InvalidUserInputServerException

Throws:

InvalidUserInputServerException

uploadAppApk

long uploadAppApk(String apiKey,
                  File apk)
           throws InvalidUserInputServerException

Throws:

InvalidUserInputServerException

startXcuiTestSuite

StartInstrumentationResponse startXcuiTestSuite(String apiKey,
                                                StaticInstrumentationRequestData requestData)

startXcuiTestSuite

StartInstrumentationResponse startXcuiTestSuite(String apiKey,
                                                DynamicInstrumentationRequestData requestData)

startAndroidSuite

StartInstrumentationResponse startAndroidSuite(String apiKey,
                                               StaticInstrumentationRequestData requestData)

startAndroidSuite

StartInstrumentationResponse startAndroidSuite(String apiKey,
                                               DynamicInstrumentationRequestData requestData)

readJunitReport

String readJunitReport(String apiKey,
                       long testReportId)

readJunitReport

String readJunitReport(String apiKey,
                       List<Long> testReportIds)

waitForInstrumentationReport

InstrumentationReport waitForInstrumentationReport(String apiKey,
                                                   long testSuiteReportId,
                                                   long waitTimeoutMs,
                                                   long sleepTimeMs)
                                            throws TimeoutException

Throws:

TimeoutException

getSessionReports

PaginationObject<SessionReport> getSessionReports(String userId,
                                                  long offset,
                                                  int limit,
                                                  int lastDays,
                                                  String apiKey)

getAvailableDeviceDescriptors

List<DeviceDescriptor> getAvailableDeviceDescriptors()

getAvailableDeviceDescriptorIds

List<String> getAvailableDeviceDescriptorIds()

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable