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

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

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

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

קבלת מצב הקריאה של השרשור של המשתמש המתקשר

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

• מציינים את היקף ההרשאות של chat.users.readstate או chat.users.readstate.readonly.
• קוראים לשיטה GetThreadReadState() ומעבירים את name של מצב הקריאה של השרשור כדי לקבל את המידע הבא: מזהה משתמש או כינוי ומזהה מרחב. האפשרות לקבל את סטטוס הקריאה של השרשור תומכת רק בקבלת סטטוס הקריאה של המשתמש שביצע את הקריאה. כדי לציין את המשתמש, צריך להגדיר אחת מהאפשרויות הבאות:
  • הכינוי 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.

בדוגמה הבאה מקבלים את מצב הקריאה של השרשור של המשתמש המתקשר:

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

await main();

כדי להריץ את הדוגמה הזו, מחליפים את הערכים הבאים:

• ‫SPACE_NAME: המזהה מname של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces() או מכתובת ה-URL של המרחב.
• ‫THREAD_NAME: המזהה מתוך name של השרשור. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות שם מותאם אישית שהוקצה להודעה בזמן היצירה.

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

נושאים קשורים

• עדכון סטטוס הקריאה של המרחב של המשתמש המתקשר.
• קבלת מצב הקריאה של המרחב של המשתמש המתקשר.