delete method
Deletes a named space.
Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the following types of authentication:
App authentication
with
administrator approval and
the authorization scope: -
https://www.googleapis.com/auth/chat.app.delete
(only in spaces the app
created) -
User authentication
with one of the following authorization scopes: -
https://www.googleapis.com/auth/chat.delete
-
https://www.googleapis.com/auth/chat.import
(import mode spaces only) -
User authentication grants administrator privileges when an administrator
account authenticates, use_admin_access
is true
, and the following
authorization scope is used: -
https://www.googleapis.com/auth/chat.admin.delete
Request parameters:
name
- Required. Resource name of the space to delete. Format:
spaces/{space}
Value must have pattern ^spaces/\[^/\]+$
.
useAdminAccess
- Optional. When true
, the method runs using the user's
Google Workspace administrator privileges. The calling user must be a
Google Workspace administrator with the
manage chat and spaces conversations privilege.
Requires the chat.admin.delete
OAuth 2.0 scope.
$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.bool? useAdminAccess,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (useAdminAccess != null) 'useAdminAccess': ['${useAdminAccess}'],
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>);
}