به‌روزرسانی وضعیت خوانده شدن رشته کاربر

این راهنما توضیح می‌دهد که چگونه از روش update در منبع ThreadReadState در Google Chat API برای علامت‌گذاری رشته‌های پیام به‌عنوان خوانده‌شده یا خوانده‌نشده استفاده کنید.

منبع ThreadReadState منبعی تک‌عضوی است که جزئیات مربوط به آخرین پیام خوانده‌شده کاربر مشخص‌شده را در رشته پیام Google Chat نشان می‌دهد.

پیش‌نیازها

Node.js

Python

به‌روزرسانی وضعیت خوانده شدن رشته کاربر تماس‌گیرنده

برای به‌روزرسانی وضعیت خوانده شدن کاربر در رشته پیام، موارد زیر را در درخواستتان اضافه کنید:

  • حوزه مجوز chat.users.readstate را مشخص کنید.
  • روش UpdateThreadReadState را فراخوانی کنید.
  • updateMask را با مقدار lastReadTime ارسال کنید.
  • مجوز threadReadState را به‌عنوان نمونه‌ای از ThreadReadState با موارد زیر ارسال کنید:
    • فیلد 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.
    • فیلد lastReadTime روی مُهر زمانی تنظیم شده است که آخرین موقعیت خواندن کاربر تماس‌گیرنده را در رشته مشخص می‌کند، مانند مُهر زمان آخرین پیام خوانده‌شده یا زمان فعلی:
      • علامت‌گذاری به‌عنوان خوانده‌نشده: lastReadTime را روی مُهر زمان زودتر از زمان ایجاد آخرین پیام در رشته تنظیم کنید. در Chat، رشته از آن مُهر زمان به بعد به‌عنوان خوانده‌نشده نشان داده می‌شود، نشان‌های خوانده‌نشده به‌روز می‌شود، رشته پررنگ می‌شود، و در صفحه اصلی ظاهر می‌شود.
      • علامت‌گذاری به‌عنوان خوانده‌شده: lastReadTime را روی مُهر زمانی برابر یا جدیدتر از زمان ایجاد آخرین پیام در رشته تنظیم کنید. اگر مُهر زمان آینده را مشخص کنید، API مقدار lastReadTime را به زمان درخواست فعلی تغییر می‌دهد.
      • حداقل مُهر زمان: فیلد lastReadTime باید در تاریخ یونیکس (1970-01-01T00:00:00Z) یا پس‌از آن باشد. تنظیم مُهر زمان منفی (قبل‌از 1970-01-01T00:00:00Z) خطای INVALID_ARGUMENT (400) را برمی‌گرداند.

مثال زیر وضعیت خوانده شدن رشته کاربر تماس‌گیرنده را به‌روز می‌کند:

Node.js

/**
 * This sample shows how to update the calling user's thread read state.
 *
 * It relies on the @google-apps/chat npm package.
 */
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: await auth.getClient({
      scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
    })
  });

  // Initialize request arguments.
  const request = {
    threadReadState: {
      name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
      lastReadTime: {
        seconds: Math.floor(Date.now() / 1000),
        nanos: 0
      }
    },
    updateMask: {
      paths: ['last_read_time']
    }
  };

  // Make the request
  const response = await chatClient.updateThreadReadState(request);
  console.log(response);
}

main().catch(console.error);

Python

"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2

# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

def update_thread_read_state():
    # Authenticate with Chat API using user credentials.
    credentials, _ = google.auth.default(
        scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
    )
    client = chat_v1.ChatServiceClient(credentials=credentials)

    # Set timestamp for last read time.
    now = timestamp_pb2.Timestamp()
    now.GetCurrentTime()

    thread_read_state = chat_v1.ThreadReadState(
        name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
        last_read_time=now,
    )

    request = chat_v1.UpdateThreadReadStateRequest(
        thread_read_state=thread_read_state,
        update_mask={"paths": ["last_read_time"]},
    )

    response = client.update_thread_read_state(request=request)
    print(response)

if __name__ == "__main__":
    update_thread_read_state()

برای اجرای این نمونه، موارد زیر را جایگزین کنید:

  • SPACE_NAME: شناسه از name فضا. می‌توانید شناسه را با فراخوانی روش ListSpaces یا از نشانی وب فضا دریافت کنید.
  • ‫THREAD_NAME: شناسه از name رشته. می‌توانید شناسه را از بدنه پاسخ برگردانده‌شده پس‌از ایجاد پیام به‌صورت ناهمگام با Chat API، یا با نام سفارشی اختصاص‌داده‌شده به پیام در زمان ایجاد دریافت کنید.

‫Chat API وضعیت خوانده شدن رشته مشخص‌شده را به‌روز می‌کند و نمونه‌ای از ThreadReadState را برمی‌گرداند.