Atualizar as configurações de notificação de um usuário no espaço

Este guia explica como usar o método patch() no recurso SpaceNotificationSetting da API Google Chat para atualizar as configurações de notificação de espaço de um usuário.

O recurso SpaceNotificationSetting é um recurso singleton que representa detalhes sobre as configurações de notificação de espaço de um usuário específico.

Pré-requisitos

Node.js

Atualizar as configurações de notificação do espaço do usuário que está fazendo a chamada

Para atualizar a configuração de notificação de um espaço de um usuário, inclua o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.users.spacesettings.
  • Chame o método UpdateSpaceNotificationSetting() transmitindo a solicitação UpdateSpaceNotificationSetting para conter as mudanças nas configurações de notificação. A solicitação inclui:
    • spaceNotificationSetting com as seguintes propriedades:
      • A propriedade name especifica quais configurações de notificação do espaço serão atualizadas, incluindo um ID ou alias de usuário e um ID do espaço. A atualização das configurações de notificação do espaço só é compatível com a atualização das configurações de notificação do usuário que fez a chamada, que pode ser especificada definindo uma das seguintes opções:
        • O alias me. Por exemplo, users/me/spaces/SPACE/spaceNotificationSetting.
        • O endereço de e-mail do Google Workspace do usuário que está fazendo a chamada. Por exemplo, users/user@example.com/spaces/SPACE/spaceNotificationSetting.
        • O ID do usuário que está fazendo a chamada. Por exemplo, users/USER/spaces/SPACE/spaceNotificationSetting.
      • O notificationSetting define o nível de notificação, como ALL, OFF.
      • O muteSetting: define se o mudo está ativado ou desativado. Os valores podem ser MUTED ou UNMUTED.
    • updateMask: define os campos de atualização e pode incluir notification_setting, mute_setting.

O exemplo a seguir atualiza a configuração de notificação do espaço do usuário que está fazendo a chamada:

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

Para executar esta amostra, substitua SPACE_NAME pelo ID do name do espaço. Você pode conseguir o ID chamando o método ListSpaces() ou no URL do espaço.

A API Google Chat atualiza as configurações de notificação do espaço especificado e retorna uma instância de SpaceNotificationSetting.