get method
Returns details about a space.
For an example, see Get details about a space. Supports the following types of authentication:
App authentication
with one of the following authorization scopes: -
https://www.googleapis.com/auth/chat.bot
-
https://www.googleapis.com/auth/chat.app.spaces
with
administrator approval -
User authentication
with one of the following authorization scopes: -
https://www.googleapis.com/auth/chat.spaces.readonly
-
https://www.googleapis.com/auth/chat.spaces
- User authentication grants
administrator privileges when an administrator account authenticates,
use_admin_access
is true
, and one of the following authorization
scopes is used: -
https://www.googleapis.com/auth/chat.admin.spaces.readonly
-
https://www.googleapis.com/auth/chat.admin.spaces
App authentication has
the following limitations: - space.access_settings
is only populated
when using the chat.app.spaces
scope. -
space.predefind_permission_settings
and space.permission_settings
are
only populated when using the chat.app.spaces
scope, and only for spaces
the app created.
Request parameters:
name
- Required. Resource name of the space, in the form
spaces/{space}
. 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.spaces
or chat.admin.spaces.readonly
OAuth 2.0 scopes.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Space.
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<Space> get(
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_,
'GET',
queryParams: queryParams_,
);
return Space.fromJson(response_ as core.Map<core.String, core.dynamic>);
}