קבלת פרטים על מצב קריאת השרשור של המשתמש

במדריך הזה מוסבר איך להשתמש בשיטה get() במשאב ThreadReadState של Google Chat API כדי לקבל פרטים על מצב הקריאה של משתמש בשרשור הודעות. במאמר איך רואים את סטטוס הקריאה של משתמשים במרחב משותף מוסבר איך לבדוק את סטטוס הקריאה של הודעה במרחב משותף.

משאב ThreadReadState הוא משאב יחיד שמייצג פרטים על ההודעה האחרונה שקראה משתמש מסוים בשרשור הודעות ב-Google Chat.

דרישות מוקדמות

Node.js

אחזור סטטוס הקריאה של המשתמש הקורא בשרשור

כדי לקבל פרטים על סטטוס הקריאה של משתמש בשרשור הודעות, צריך לכלול בבקשה את הפרטים הבאים:

  • מציינים את היקף ההרשאה chat.users.readstate או chat.users.readstate.readonly.
  • קוראים ל-method‏ GetThreadReadState(), מעבירים את name של מצב הקריאה של השרשור כדי לקבל את ה-get שכולל מזהה משתמש או כינוי ומזהה מרחב. אחזור סטטוס הקריאה של שרשור תומך רק באחזור סטטוס הקריאה של המשתמש הקורא. אפשר לציין את סטטוס הקריאה באמצעות אחת מהאפשרויות הבאות:
    • הכינוי me. לדוגמה, users/me/spaces/SPACE/threads/THREAD/threadReadState.
    • כתובת האימייל של המשתמש מבצע הקריאה ב-Workspace. לדוגמה, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
    • מזהה המשתמש של מבצע הקריאה. לדוגמה, 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 של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method‏ ListSpaces() או מכתובת ה-URL של המרחב המשותף.
  • THREAD_NAME: המזהה מ-name של השרשור. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכררוני באמצעות Chat API, או באמצעות השם המותאם אישית שהוקצה להודעה בזמן היצירה.

‏Google Chat API מקבל את סטטוס הקריאה של השרשור שצוין ומחזיר מופע של ThreadReadState.