delete method

Future<Empty> delete(
  1. String name, {
  2. List<String>? wipeDataFlags,
  3. String? wipeReasonMessage,
  4. String? $fields,
})

Deletes a device.

This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.

Request parameters:

name - The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. Value must have pattern ^enterprises/\[^/\]+/devices/\[^/\]+$.

wipeDataFlags - Optional flags that control the device wiping behavior.

wipeReasonMessage - Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Empty.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Empty> delete(
  core.String name, {
  core.List<core.String>? wipeDataFlags,
  core.String? wipeReasonMessage,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (wipeDataFlags != null) 'wipeDataFlags': wipeDataFlags,
    if (wipeReasonMessage != null) 'wipeReasonMessage': [wipeReasonMessage],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'DELETE',
    queryParams: queryParams_,
  );
  return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}