myhomie_app/mycore_api/doc/ScreenDeviceApi.md

mycore_api.api.ScreenDeviceApi

Load the API package

import 'package:mycore_api/api.dart';

All URIs are relative to http://localhost:25049

Method	HTTP request	Description
screenDeviceCreateDevice	POST /api/device/screen	Create screen device
screenDeviceDeleteDevice	DELETE /api/device/screen/{deviceId}	Delete device
screenDeviceGetAllScreenDevices	GET /api/device/screen	Get all screen devices
screenDeviceGetDeviceInfo	GET /api/device/screen/{screenDeviceId}	Get screen device info
screenDeviceUpdateDevice	PUT /api/device/screen	Update screen device

screenDeviceCreateDevice

ScreenDevice screenDeviceCreateDevice(screenDevice)

Create screen device

Example

import 'package:mycore_api/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	Screen device to create

Return type

ScreenDevice

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

screenDeviceDeleteDevice

String screenDeviceDeleteDevice(deviceId)

Delete device

Example

import 'package:mycore_api/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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

screenDeviceGetAllScreenDevices

List screenDeviceGetAllScreenDevices()

Get all screen devices

Example

import 'package:mycore_api/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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

screenDeviceGetDeviceInfo

ScreenDevice screenDeviceGetDeviceInfo(screenDeviceId)

Get screen device info

Example

import 'package:mycore_api/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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

screenDeviceUpdateDevice

ScreenDevice screenDeviceUpdateDevice(screenDevice)

Update screen device

Example

import 'package:mycore_api/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	Screen device to update

Return type

ScreenDevice

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]