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

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

SpaceNotificationSetting 资源是一个单例资源，用于表示指定用户的聊天室通知设置的详细信息。

前提条件

Node.js

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 安装 Node.js Cloud 客户端库。
  • 为桌面应用 创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例，请将凭据保存为名为 client_secrets.json 的 JSON 文件，并保存到本地目录。
  如需相关指导，请完成此快速入门中关于设置环境的步骤。
• 选择支持用户身份验证的授权范围。

本页中的代码示例使用 gRPC API 与 Google Cloud 客户端库交互。或者，您也可以使用 REST API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

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

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

• 指定 chat.users.spacesettings 授权范围。
• 调用 UpdateSpaceNotificationSetting() 方法，传递包含通知设置更改的 UpdateSpaceNotificationSetting 请求。该请求包含：
  • spaceNotificationSetting，具有以下属性：
    • name 属性用于指定要更新的聊天室通知设置，其中包括用户 ID 或别名和聊天室 ID。更新聊天室通知设置仅支持更新发起通话的用户的通知设置，您可以通过设置以下任一项来指定该用户：
      • me 别名。例如 users/me/spaces/SPACE/spaceNotificationSetting。
      • 发起通话的用户的 Workspace 电子邮件地址。例如，users/[e-mail]/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

在 GitHub 上查看

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 的实例。

相关主题

• 获取发起通话的用户的聊天室通知设置。