获取有关用户聊天室读取状态的详细信息

本指南介绍了如何使用 get() 方法SpaceReadState,获取有关 用户在聊天室内的已读状态的详细信息。如需获取 消息串中消息的已读状态,请参阅 获取有关用户串已读状态的详细信息

SpaceReadState 资源 是一种单例资源,用于表示有关 指定用户在 Google Chat 聊天室中最后一条已读消息的详细信息。

前提条件

Node.js

获取调用用户的聊天室已读状态

如需获取有关用户在聊天室内的已读状态的详细信息,请在请求中添加以下内容:

  • 指定 chat.users.readstatechat.users.readstate.readonly 授权范围。
  • 调用 GetSpaceReadState() 方法,传递要获取的聊天室已读状态的 name,其中包括 用户 ID 或别名以及聊天室 ID。获取聊天室已读状态仅支持获取调用用户的已读状态,您可以通过设置以下其中一项来指定调用用户:
    • me 别名。例如, users/me/spaces/SPACE/spaceReadState
    • 调用用户的 Workspace 电子邮件地址。例如, users/user@example.com/spaces/SPACE/spaceReadState
    • 调用用户的用户 ID。例如, users/USER/spaces/SPACE/spaceReadState

以下示例用于获取调用用户的聊天室已读状态:

Node.js

chat/client-libraries/cloud/get-space-read-state-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.readstate.readonly',
];

// This sample shows how to get the space read state for the calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState',
  };

  // Make the request
  const response = await chatClient.getSpaceReadState(request);

  // Handle the response
  console.log(response);
}

await main();

如需运行此示例,请将 SPACE_NAME 替换为 聊天室 name中的 ID。 您可以通过调用 ListSpaces() 方法或从聊天室的网址获取 ID。

Google Chat API 会获取指定的聊天室已读状态,并返回 an instance of SpaceReadState