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

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

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

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

עדכון הגדרות ההתראות של המרחב המשותף של המשתמש שמבצע את השיחה

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

• מציינים את היקף ההרשאה chat.users.spacesettings.
• קוראים ל-method‏ 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.

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

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

main().catch(console.error);

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

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

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

• איך לקבל את הגדרת ההתראות של המרחב המשותף של המשתמש המתקשר