mirror of
https://bitbucket.org/myhomie/mycorerepository.git
synced 2025-12-06 17:51:20 +00:00
232 lines
6.5 KiB
Markdown
232 lines
6.5 KiB
Markdown
# mycoreapi.api.ScreenDeviceApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:mycoreapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://192.168.31.140*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**screenDeviceCreateDevice**](ScreenDeviceApi.md#screendevicecreatedevice) | **POST** /api/device/screen |
|
|
[**screenDeviceDeleteDevice**](ScreenDeviceApi.md#screendevicedeletedevice) | **DELETE** /api/device/screen/{deviceId} |
|
|
[**screenDeviceGetAllScreenDevices**](ScreenDeviceApi.md#screendevicegetallscreendevices) | **GET** /api/device/screen |
|
|
[**screenDeviceGetDeviceInfo**](ScreenDeviceApi.md#screendevicegetdeviceinfo) | **GET** /api/device/screen/{screenDeviceId} |
|
|
[**screenDeviceUpdateDevice**](ScreenDeviceApi.md#screendeviceupdatedevice) | **PUT** /api/device/screen/{screenDeviceId} |
|
|
|
|
|
|
# **screenDeviceCreateDevice**
|
|
> MultipartFile screenDeviceCreateDevice(screenDevice)
|
|
|
|
|
|
|
|
### 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 |
|
|
|
|
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)| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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**
|
|
> MultipartFile screenDeviceDeleteDevice(deviceId)
|
|
|
|
|
|
|
|
### 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 |
|
|
|
|
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**| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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()
|
|
|
|
|
|
|
|
### 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)
|
|
|
|
|
|
|
|
### 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**
|
|
> MultipartFile screenDeviceUpdateDevice(screenDeviceId, screenDevice)
|
|
|
|
|
|
|
|
### 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 = 56; // int |
|
|
final screenDevice = ScreenDevice(); // ScreenDevice |
|
|
|
|
try {
|
|
final result = api_instance.screenDeviceUpdateDevice(screenDeviceId, screenDevice);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ScreenDeviceApi->screenDeviceUpdateDevice: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**screenDeviceId** | **int**| |
|
|
**screenDevice** | [**ScreenDevice**](ScreenDevice.md)| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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)
|
|
|