myhomie_app/mycore_api/doc/AlarmApi.md

mycoreapi.api.AlarmApi

Load the API package

import 'package:mycoreapi/api.dart';

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

Method	HTTP request	Description
alarmActivate	POST /api/alarm/activate/{alarmModeId}	Activate specified alarm mode
alarmCreate	POST /api/alarm	Create an alarm mode
alarmCreateDefaultAlarms	POST /api/alarm/defaults/{homeId}	Create default alarm modes
alarmDelete	DELETE /api/alarm/{alarmModeId}	Delete an alarm mode
alarmDeleteAllForHome	DELETE /api/alarm/home/{homeId}	Delete all alarm mode for a specified home
alarmGetAll	GET /api/alarm/{homeId}	Get all alarm modes for the specified home
alarmGetDetail	GET /api/alarm/detail/{alarmModeId}	Get detail info of a specified alarm mode
alarmUpdate	PUT /api/alarm	Update an alarm mode

alarmActivate

String alarmActivate(alarmModeId)

Activate specified alarm mode

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeId = alarmModeId_example; // String | Alarm mode to activate

try { 
    final result = api_instance.alarmActivate(alarmModeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmActivate: $e\n');
}

Parameters

Name	Type	Description	Notes
alarmModeId	String	Alarm mode to activate

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]

alarmCreate

AlarmModeDetailDTO alarmCreate(alarmModeCreateOrUpdateDetailDTO)

Create an alarm mode

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeCreateOrUpdateDetailDTO = AlarmModeCreateOrUpdateDetailDTO(); // AlarmModeCreateOrUpdateDetailDTO | Alarm mode to create

try { 
    final result = api_instance.alarmCreate(alarmModeCreateOrUpdateDetailDTO);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
alarmModeCreateOrUpdateDetailDTO	AlarmModeCreateOrUpdateDetailDTO	Alarm mode to create

Return type

AlarmModeDetailDTO

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]

alarmCreateDefaultAlarms

bool alarmCreateDefaultAlarms(homeId)

Create default alarm modes

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final homeId = homeId_example; // String | Home Id

try { 
    final result = api_instance.alarmCreateDefaultAlarms(homeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmCreateDefaultAlarms: $e\n');
}

Parameters

Name	Type	Description	Notes
homeId	String	Home Id

Return type

bool

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]

alarmDelete

String alarmDelete(alarmModeId)

Delete an alarm mode

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeId = alarmModeId_example; // String | Id of alarm mode to delete

try { 
    final result = api_instance.alarmDelete(alarmModeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmDelete: $e\n');
}

Parameters

Name	Type	Description	Notes
alarmModeId	String	Id of alarm mode to delete

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]

alarmDeleteAllForHome

String alarmDeleteAllForHome(homeId)

Delete all alarm mode for a specified home

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final homeId = homeId_example; // String | Home Id

try { 
    final result = api_instance.alarmDeleteAllForHome(homeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmDeleteAllForHome: $e\n');
}

Parameters

Name	Type	Description	Notes
homeId	String	Home Id

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]

alarmGetAll

List alarmGetAll(homeId)

Get all alarm modes for the specified home

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final homeId = homeId_example; // String | Home Id

try { 
    final result = api_instance.alarmGetAll(homeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmGetAll: $e\n');
}

Parameters

Name	Type	Description	Notes
homeId	String	Home Id

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]

alarmGetDetail

AlarmModeDetailDTO alarmGetDetail(alarmModeId)

Get detail info of a specified alarm mode

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeId = alarmModeId_example; // String | alarm id

try { 
    final result = api_instance.alarmGetDetail(alarmModeId);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmGetDetail: $e\n');
}

Parameters

Name	Type	Description	Notes
alarmModeId	String	alarm id

Return type

AlarmModeDetailDTO

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]

alarmUpdate

AlarmModeDetailDTO alarmUpdate(alarmModeCreateOrUpdateDetailDTO)

Update an alarm mode

Example

import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AlarmApi();
final alarmModeCreateOrUpdateDetailDTO = AlarmModeCreateOrUpdateDetailDTO(); // AlarmModeCreateOrUpdateDetailDTO | alarm mode to update

try { 
    final result = api_instance.alarmUpdate(alarmModeCreateOrUpdateDetailDTO);
    print(result);
} catch (e) {
    print('Exception when calling AlarmApi->alarmUpdate: $e\n');
}

Parameters

Name	Type	Description	Notes
alarmModeCreateOrUpdateDetailDTO	AlarmModeCreateOrUpdateDetailDTO	alarm mode to update

Return type

AlarmModeDetailDTO

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]