timerGet method

Future<Map<String, dynamic>> timerGet(
  1. String id
)
inherited

timerGet -> /v1/timer/{id}

Requests the details of the specified timer.

PARAMETERS

id (required) : The ID of the timer, either name, index or UUID.

  • Example (by_name): Timer Name
  • Example (by_index): 3
  • Example (by_uuid): 3C39C433-5C18-4F51-B357-55BB870227C4

RESPONSE 200:

The request was processed successfully.

content-type: application/json

schema:

{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "id",
        "allows_overrun"
      ]
    },
    {
      "type": "object",
      "required": [
        "id",
        "allows_overrun"
      ]
    },
    {
      "type": "object",
      "required": [
        "id",
        "allows_overrun"
      ]
    }
  ]
}

Implementation

Future<Map<String, dynamic>> timerGet(String id) async {
  String url = '/v1/timer/$id';

  return await call('get', url, httpAccept: 'application/json');
}