Receber detalhes sobre o estado de leitura da conversa de um usuário

Este guia explica como usar o método get() no recurso ThreadReadState da API Google Chat para receber detalhes sobre o estado de leitura de um usuário em uma conversa por mensagem. Para saber o estado de leitura de uma mensagem em um espaço, consulte Receber detalhes sobre o estado de leitura de um espaço de um usuário.

O recurso ThreadReadState é um recurso singleton que representa detalhes sobre a última mensagem lida de um usuário especificado em uma conversa do Google Chat.

Pré-requisitos

Node.js

Receber o estado de leitura da linha de execução do usuário que fez a chamada

Para conferir detalhes sobre o estado de leitura de um usuário em uma conversa por mensagem, inclua o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.users.readstate ou chat.users.readstate.readonly.
  • Chame o método GetThreadReadState() e transmita o name do estado de leitura da conversa para saber qual inclui um ID ou alias de usuário e um ID de espaço. A obtenção do estado de leitura da linha de execução só é compatível com a obtenção do estado de leitura do usuário que fez a chamada, que pode ser especificado definindo uma das seguintes opções:
    • O alias me. Por exemplo, users/me/spaces/SPACE/threads/THREAD/threadReadState.
    • O endereço de e-mail do Google Workspace do usuário que está fazendo a chamada. Por exemplo, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
    • O ID do usuário que está fazendo a chamada. Por exemplo, users/USER/spaces/SPACE/threads/THREAD/threadReadState.

O exemplo a seguir recebe o estado de leitura da linha de execução do usuário que fez a chamada:

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);

Para executar esta amostra, substitua o seguinte:

  • SPACE_NAME: o ID do name do espaço. Você pode conseguir o ID chamando o método ListSpaces() ou no URL do espaço.
  • THREAD_NAME: o ID do name da linha de execução. É possível receber o ID do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem na criação.

A API Google Chat recebe o estado de leitura da conversa especificada e retorna uma instância de ThreadReadState.