获取有关用户的线程读取状态的详细信息

本指南介绍了如何对 Google Chat API 的 ThreadReadState 资源使用 get() 方法，以获取消息会话中用户的阅读状态的详细信息。如需获取聊天室中消息的已读状态，请参阅详细了解用户的聊天室已读状态。

ThreadReadState 资源是一个单例资源，用于表示指定用户在 Google Chat 消息会话中上次读取的消息的详细信息。

前提条件

Node.js

获取调用用户的线程读取状态

如需详细了解用户在消息会话中的阅读状态，请在请求中添加以下内容：

  • 指定 chat.users.readstate 或 chat.users.readstate.readonly 授权范围。
  • 调用 GetThreadReadState() 方法，传递要获取的线程读取状态的 name，其中包含用户 ID 或别名和聊天室 ID。获取线程读取状态仅支持获取调用方用户的读取状态，您可以通过设置以下任一项来指定该状态：
    • me 别名。例如 users/me/spaces/SPACE/threads/THREAD/threadReadState。
    • 发起通话的用户的 Workspace 电子邮件地址。例如，users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState。
    • 发起调用的用户的用户 ID。例如，users/USER/spaces/SPACE/threads/THREAD/threadReadState。

以下示例会获取调用用户的线程读取状态：

Node.js

chat/client-libraries/cloud/get-thread-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 thread read state for a space and 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 and THREAD_NAME here
    name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'
  };

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

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

main().catch(console.error);

如需运行此示例，请替换以下内容：

  • SPACE_NAME：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取此 ID。
  • THREAD_NAME：线程的 name 中的 ID。您可以通过以下方式获取 ID：使用 Chat API 异步创建消息后从返回的响应正文中获取，或者使用在创建消息时分配给消息的自定义名称获取。

Google Chat API 会获取指定会话的读取状态，并返回 ThreadReadState 的实例。