https://github.com/mega6453/seetestcloudapi
A simple and easy Nuget library to manage Mobile Devices hosted in the SeeTest Cloud.
https://github.com/mega6453/seetestcloudapi
seetest seetest-cloud
Last synced: 2 months ago
JSON representation
A simple and easy Nuget library to manage Mobile Devices hosted in the SeeTest Cloud.
- Host: GitHub
- URL: https://github.com/mega6453/seetestcloudapi
- Owner: mega6453
- Created: 2020-07-19T10:19:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T07:59:54.000Z (over 1 year ago)
- Last Synced: 2025-03-10T01:13:54.823Z (3 months ago)
- Topics: seetest, seetest-cloud
- Language: C#
- Homepage: https://www.nuget.org/packages/SeeTestCloudAPI
- Size: 505 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SeeTestCloudAPI 
A simple and easy library to manage Mobile Devices hosted in the SeeTest Cloud.
### Prerequisites
```
A .NetStandard v2.0 / .NetFramework v4.5.2 project
SeeTestCloud Access
```
### Installing
```
Right Click on your project in the visual studio solution explorer->Manage nuget packages-> Search for SeeTestCloudAPI -> Select SeeTestCloudAPI By Meganathan from the list -> Select project -> Install.
Gathering dependency information may take a minute or more.
```
## How to Use? It's simple!
Import "SeeTestCloudAPI".
```
using SeeTestCloudAPI;
```
Create a new instance of CloudAPIClient with the SeeTest Cloud server URL and credentials(Token / Username & Password)
```
CloudAPIClient client = new CloudAPIClient("CloudServerURL", "AccessToken");
CloudServerURL = The URL where the SeeTestCloud server is configured.
AccessToken = Login to SeeTestCloud->User Icon->Get Access Key->Copy.
e.g. CloudAPIClient client = new CloudAPIClient("https://xxxxx.com", "xxxxxxxxxxx");
```
Use the created instance to call the available methods.
```
e.g.
client.GetAvailableDevicesNames();
client.PrintAllDevicesImportantInformation();
```
To use Device specific methods, Device ID(Assigned by SeeTestCloud) is required. Use GetDeviceID() method to get the Device ID.
```
// Use UDID of a Device to get Device ID.
int DeviceID = client.GetDeviceID(string UDID); // iOS - UDID; Android - Serial number.
OR
// Use Queries to filter the device and Get Device ID.
Dictionary SearchQuery = new Dictionary();
SearchQuery.Add(Keys.agentLocation, "Bangalore"); // Keys is a enum which will have all the keys. So, just need to type "Keys." -> will list out all the keys.
SearchQuery.Add(Keys.deviceOs, "android");
SearchQuery.Add(Keys.displayStatus, "available");
SearchQuery.Add(Keys.model, "Nexus 5X");
int DeviceID = client.GetDeviceID(SearchQuery);
OR
// Use below method to print all the device's Location,DeviceName,DeviceOS,OSVersion,CurrentStatus,DeviceID and UDID details in the console.
client.PrintAllDevicesImportantInformation();
```
Use the Device ID in the Device specific methods.
```
e.g.
client.ReserveDevice(DeviceID, "2020-07-13-16-30-00", "2020-07-13-16-30-00", "2020-07-13-16-50-00"); // Will Reserve the device and will return the response as string.
```
## Available Methods
No much information added here about the methods since all the methods are having description and parameter info which will be displayed while using the methods.
```
AddDeviceTag()
EditDevice()
GetAllDevices() (+ 3 overloads)
GetAvailableDevicesIDs() (+ 1 overload) - Added in v1.2.0
GetAvailableDevicesNames() (+ 1 overload)
GetAvailableDevicesNamesWithDetails() (+ 1 overload)
GetDevice() (+ 2 overloads)
GetDeviceID() (+ 1 overload)
GetDeviceIDList() - Added in v1.2.0
GetDeviceiOSConfigurationProfiles()
GetDeviceReservations()
GetDeviceTags()
GetOnlineDevicesIDs() (+ 1 overload) - Added in v1.2.0
GetOnlineDevicesNames() (+ 1 overload)
PrintAllDevicesImportantInformation()
RebootDevice()
ReleaseDevice()
RemoveAllTagsOfDevice()
RemoveDeviceTag()
ReserveDevice()
ReserveMultipleDevices()
ResetUSBConnection()
StartWebControl() (+ 3 overloads) - Added two new methods in v1.1.0
```
More methods will be added in the future releases.
## Built With
* [SeeTestCloud APIs](https://docs.experitest.com/display/PM/Devices+Rest+API) - The Official Raw Rest APIs
* [Restsharp](https://www.nuget.org/packages/RestSharp) - API Management
* [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/) - Json Management
## Authors
* [**Meganathan C**](https://mega6453.carrd.co)
## Want to add features or fix things?
* Clone the Repo
* Make changes
* Create a pull request
## License
This project is licensed under the [MIT License](https://licenses.nuget.org/MIT)