mirror of
https://bitbucket.org/myhomie/mycorerepository.git
synced 2025-12-06 17:51:20 +00:00
230 lines
6.6 KiB
Markdown
230 lines
6.6 KiB
Markdown
# mycoreapi.api.ScreenDeviceApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost:25049*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**screenDeviceCreateDevice**](ScreenDeviceApi.md#screendevicecreatedevice) | **POST** /api/device/screen | Create screen device
|
|
[**screenDeviceDeleteDevice**](ScreenDeviceApi.md#screendevicedeletedevice) | **DELETE** /api/device/screen/{deviceId} | Delete device
|
|
[**screenDeviceGetAllScreenDevices**](ScreenDeviceApi.md#screendevicegetallscreendevices) | **GET** /api/device/screen | Get all screen devices
|
|
[**screenDeviceGetDeviceInfo**](ScreenDeviceApi.md#screendevicegetdeviceinfo) | **GET** /api/device/screen/{screenDeviceId} | Get screen device info
|
|
[**screenDeviceUpdateDevice**](ScreenDeviceApi.md#screendeviceupdatedevice) | **PUT** /api/device/screen | Update screen device
|
|
|
|
|
|
# **screenDeviceCreateDevice**
|
|
> ScreenDevice screenDeviceCreateDevice(screenDevice)
|
|
|
|
Create screen device
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ScreenDeviceApi();
|
|
final screenDevice = ScreenDevice(); // ScreenDevice | Screen device to create
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceCreateDevice(screenDevice);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceCreateDevice: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**screenDevice** | [**ScreenDevice**](ScreenDevice.md)| Screen device to create |
|
|
|
|
### Return type
|
|
|
|
[**ScreenDevice**](ScreenDevice.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **screenDeviceDeleteDevice**
|
|
> String screenDeviceDeleteDevice(deviceId)
|
|
|
|
Delete device
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ScreenDeviceApi();
|
|
final deviceId = deviceId_example; // String | Screen device id to update
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceDeleteDevice(deviceId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceDeleteDevice: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**deviceId** | **String**| Screen device id to update |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **screenDeviceGetAllScreenDevices**
|
|
> List<ScreenDevice> screenDeviceGetAllScreenDevices()
|
|
|
|
Get all screen devices
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ScreenDeviceApi();
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceGetAllScreenDevices();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceGetAllScreenDevices: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<ScreenDevice>**](ScreenDevice.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **screenDeviceGetDeviceInfo**
|
|
> ScreenDevice screenDeviceGetDeviceInfo(screenDeviceId)
|
|
|
|
Get screen device info
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ScreenDeviceApi();
|
|
final screenDeviceId = screenDeviceId_example; // String | Id of the screen device you want to get information
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceGetDeviceInfo(screenDeviceId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceGetDeviceInfo: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**screenDeviceId** | **String**| Id of the screen device you want to get information |
|
|
|
|
### Return type
|
|
|
|
[**ScreenDevice**](ScreenDevice.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **screenDeviceUpdateDevice**
|
|
> ScreenDevice screenDeviceUpdateDevice(screenDevice)
|
|
|
|
Update screen device
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ScreenDeviceApi();
|
|
final screenDevice = ScreenDevice(); // ScreenDevice | Screen device to update
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceUpdateDevice(screenDevice);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceUpdateDevice: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**screenDevice** | [**ScreenDevice**](ScreenDevice.md)| Screen device to update |
|
|
|
|
### Return type
|
|
|
|
[**ScreenDevice**](ScreenDevice.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|