Обновление настроек уведомлений в чат-группе пользователя

В этом руководстве объясняется, как использовать метод patch() в ресурсе SpaceNotificationSetting API Google Chat для обновления настроек уведомлений о пространстве пользователя.

Ресурс SpaceNotificationSetting — это одноэлементный ресурс, который представляет сведения о настройках уведомлений пространства указанного пользователя.

Предпосылки

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

main().catch(console.error);

Чтобы запустить этот пример, замените SPACE_NAME на идентификатор из name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или указав URL пространства.

API Google Chat обновляет указанные настройки уведомлений пространства и возвращает экземпляр SpaceNotificationSetting .