getSpaceReadState method

Future<SpaceReadState> getSpaceReadState(String name, { String? $fields, })

Returns details about a user's read state within a space, used to identify read and unread messages.

For an example, see Get details about a user's space read state. Requires user authentication.

Request parameters:

name - Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The me alias. For example, users/me/spaces/{space}/spaceReadState. - Their Workspace email address. For example, users/[e-mail]/spaces/{space}/spaceReadState. - Their user id. For example, users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState Value must have pattern ^users/\[^/\]+/spaces/\[^/\]+/spaceReadState$.

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

Completes with a SpaceReadState.

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<SpaceReadState> getSpaceReadState(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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