Interface ICloudTestClient
A C# client to execute common device testing API requests
Namespace: TestPlatforms.Cloud
Syntax
public interface ICloudTestClientMethods
GetBuilds()
Get the existing builds for a project.
Declaration
GetBuildsResponse GetBuilds()Returns
| Type | Description |
|---|---|
| GetBuildsResponse | The 15 most recent builds from most to least recent |
GetBuilds(String, String)
Get the existing builds for a project.
Declaration
GetBuildsResponse GetBuilds(string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| GetBuildsResponse | The 15 most recent builds from most to least recent |
GetJobs()
Get the existing jobs for a project
Declaration
GetJobsResponse GetJobs()Returns
| Type | Description |
|---|---|
| GetJobsResponse | The 15 most recent jobs from most to least recent |
GetJobs(String, String)
Declaration
GetJobsResponse GetJobs(string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| GetJobsResponse |
GetJobStatus(String)
Gets the status of a job
Declaration
JobStatusResponse GetJobStatus(string jobId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId |
Returns
| Type | Description |
|---|---|
| JobStatusResponse | JobStatus |
GetJobStatus(String, String, String)
Gets the status of a job
Declaration
JobStatusResponse GetJobStatus(string jobId, string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId | |
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| JobStatusResponse | JobStatus |
GetLogs(String)
Get the logs for a given job. These logs will be returned as a signed url for each device of a job.
Declaration
GetLogResponse GetLogs(string jobId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId |
Returns
| Type | Description |
|---|---|
| GetLogResponse | GetLogResponse |
GetLogs(String, String, String)
Declaration
GetLogResponse GetLogs(string jobId, string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId | |
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| GetLogResponse |
GetTestResults(String)
Returns raw cloud test results. This includes a signed location for advanced report data and basic pass fail information
Declaration
TestResultsResponse GetTestResults(string jobId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId |
Returns
| Type | Description |
|---|---|
| TestResultsResponse | TestResultsResponse |
GetTestResults(String, String, String)
Returns raw cloud test results. This includes a signed location for advanced report data and basic pass fail information
Declaration
TestResultsResponse GetTestResults(string jobId, string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | jobId | |
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| TestResultsResponse | TestResultsResponse |
GetUploadURL()
Get a signed upload url that can be used to upload a build through a put request
Declaration
UploadUrlResponse GetUploadURL()Returns
| Type | Description |
|---|---|
| UploadUrlResponse | UploadUrlResponse including a buildId and a url |
GetUploadURL(String, String)
Get a signed upload url that can be used to upload a build through a put request
Declaration
UploadUrlResponse GetUploadURL(string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| UploadUrlResponse | UploadUrlResponse including a buildId and a url |
RunCloudTests(String, List<String>, CloudTestDeviceInput)
Runs tests on cloud for a given buildId, test list, and device list.
Declaration
JobStatusResponse RunCloudTests(string buildId, List<string> cloudTests, CloudTestDeviceInput cloudTestSubmission)Parameters
| Type | Name | Description |
|---|---|---|
| String | buildId | |
| List<String> | cloudTests | |
| CloudTestDeviceInput | cloudTestSubmission |
Returns
| Type | Description |
|---|---|
| JobStatusResponse | Initial job status |
RunCloudTests(String, List<String>, CloudTestDeviceInput, String, String)
Runs tests on cloud for a given buildId, test list, and device list.
Declaration
JobStatusResponse RunCloudTests(string buildId, List<string> cloudTests, CloudTestDeviceInput cloudTestSubmission, string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | buildId | |
| List<String> | cloudTests | |
| CloudTestDeviceInput | cloudTestSubmission | |
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| JobStatusResponse | Initial job status |
UploadBuild(String, String, String)
Combines GetUploadURL and UploadBuildToURL
Declaration
UploadUrlResponse UploadBuild(string buildPath, string accessToken, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | buildPath | |
| String | accessToken | |
| String | projectId |
Returns
| Type | Description |
|---|---|
| UploadUrlResponse | UploadUrlResponse |
UploadBuildToUrl(String, String)
Execute a put request to the given uploadURL for an artifact located at buildPath
Declaration
void UploadBuildToUrl(string uploadURL, string buildPath)Parameters
| Type | Name | Description |
|---|---|---|
| String | uploadURL | |
| String | buildPath |