clearGroupSet method

Future<Map<String, dynamic>> clearGroupSet(
  1. String id,
  2. Map postBody
)
inherited

clearGroupSet -> /v1/clear/group/{id}

Sets the details of the specified clear group.

PARAMETERS

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

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

postBody (required) : This is the data that must be sent with this request.

RESPONSE 200:

The request was processed successfully.

content-type: application/json

schema:

{
  "type": "object",
  "required": [
    "id",
    "layers",
    "icon",
    "tint",
    "stop_timeline_announcements",
    "stop_timeline_presentation",
    "clear_next_presentation"
  ]
}

RESPONSE 400:

The request was not valid.

content-type: ``

Implementation

Future<Map<String, dynamic>> clearGroupSet(String id, Map postBody) async {
  String url = '/v1/clear/group/$id';

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