איך מעדכנים את הגדרות ההתראות של המרחב המשותף של משתמש מסוים

במדריך הזה מוסבר איך להשתמש בשיטה patch() במשאב SpaceNotificationSetting של Google Chat API כדי לעדכן את הגדרות ההתראות של המרחב של המשתמש.

SpaceNotificationSetting resource הוא משאב יחיד שמייצג פרטים על הגדרות ההתראות של מרחב מסוים של משתמש.

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

Node.js

עדכון הגדרות ההתראות במרחב של המשתמש המתקשר

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

  • מציינים את chat.users.spacesettings היקף ההרשאה.
  • קוראים לשיטה UpdateSpaceNotificationSetting(), ומעבירים את הבקשה UpdateSpaceNotificationSetting כדי לכלול את השינויים בהגדרות ההתראות. הבקשה כוללת:
    • ‫spaceNotificationSetting עם המאפיינים הבאים:
      • המאפיין name מציין אילו הגדרות של התראות במרחב צריך לעדכן, כולל מזהה משתמש או כינוי ומזהה מרחב. אפשר לעדכן רק את הגדרות ההתראות של המשתמש המתקשר, שאפשר לציין אותן באמצעות הגדרת אחת מהאפשרויות הבאות:
        • הכינוי me. לדוגמה, users/me/spaces/SPACE/spaceNotificationSetting.
        • כתובת האימייל של המשתמש ב-Workspace שמבצע את השיחה. לדוגמה, users/user@example.com/spaces/SPACE/spaceNotificationSetting.
        • מזהה המשתמש של המשתמש המתקשר. לדוגמה, users/USER/spaces/SPACE/spaceNotificationSetting.
      • הפרמטר notificationSetting: מגדיר את רמת ההתראות, למשל ALL, OFF.
      • ‫muteSetting: מגדיר את ההשתקה או ביטול ההשתקה, הערכים יכולים להיות MUTED או UNMUTED.
    • ‫updateMask: הגדרת שדות העדכון, יכול לכלול את notification_setting, ‏ mute_setting.

בדוגמה הבאה מעדכנים את הגדרת ההתראות של המשתמש במרחב:

Node.js

chat/client-libraries/cloud/update-space-notification-setting-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.spacesettings',
];

// This sample shows how to update the space notification setting for the
// calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s), replace the SPACE_NAME with an actual space
  // name.
  const request = {
    spaceNotificationSetting: {
      name: 'users/me/spaces/SPACE_NAME/spaceNotificationSetting',
      notificationSetting: 'ALL',
      muteSetting: 'UNMUTED',
    },
    updateMask: {paths: ['notification_setting', 'mute_setting']},
  };

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

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

await main();

כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME במזהה מתוך name של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces() או מכתובת ה-URL של המרחב.

‫Google Chat API מעדכן את הגדרות ההתראות של המרחב שצוין ומחזיר מופע של SpaceNotificationSetting.