更新用户的聊天室通知设置

本指南介绍了如何使用 Google Chat API 的 SpaceNotificationSetting 资源中的 patch() 方法来更新用户的聊天室通知设置。

SpaceNotificationSetting 资源是一种单例资源，用于表示指定用户的空间通知设置的详细信息。

前提条件

Node.js

更新调用用户的聊天室通知设置

如需更新用户的空间通知设置，请在请求中添加以下内容：

  • 指定 chat.users.spacesettings 授权范围。
  • 调用 UpdateSpaceNotificationSetting() 方法，并传递 UpdateSpaceNotificationSetting 请求以包含对通知设置的更改。该请求包含：
    • spaceNotificationSetting 具有以下属性：
      • name 属性用于指定要更新哪些聊天室通知设置，包括用户 ID 或别名以及聊天室 ID。更新聊天室通知设置仅支持更新调用用户的通知设置，可以通过设置以下任一参数来指定：
        • me 别名。例如 users/me/spaces/SPACE/spaceNotificationSetting。
        • 调用用户的 Workspace 电子邮件地址。例如，users/user@example.com/spaces/SPACE/spaceNotificationSetting。
        • 调用用户的用户 ID。例如，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);
}

main().catch(console.error);

如需运行此示例，请将 SPACE_NAME 替换为空间 name 中的 ID。您可以通过调用 ListSpaces() 方法或从空间的网址中获取 ID。

Google Chat API 会更新指定的聊天室通知设置，并返回 SpaceNotificationSetting 的实例。