Modifier les paramètres de notification d'un espace pour un utilisateur

Ce guide explique comment utiliser la patch() méthode sur la ressource SpaceNotificationSetting de l'API Google Chat pour modifier les paramètres de notification d'un espace d'un utilisateur.

La ressource SpaceNotificationSetting est une ressource singleton qui représente les détails des paramètres de notification d'un espace d'un utilisateur spécifié.

Prérequis

Node.js

Modifier les paramètres de notification d'un espace de l'utilisateur appelant

Pour modifier les paramètres de notification d'un espace d'un utilisateur, incluez les éléments suivants dans votre requête :

  • Spécifiez le champ d'application d'autorisation chat.users.spacesettings.
  • Appelez la UpdateSpaceNotificationSetting() méthode, en transmettant la requête UpdateSpaceNotificationSetting pour contenir les modifications apportées aux paramètres de notification. La requête inclut les éléments suivants :
    • spaceNotificationSetting avec les propriétés suivantes :
      • La propriété name spécifie les paramètres de notification d'espace à modifier, y compris un ID utilisateur ou un alias et un ID d'espace. La modification des paramètres de notification d'espace n'est possible que pour l'utilisateur appelant, qui peut être spécifié en définissant l'un des éléments suivants :
        • L'alias me. Par exemple, users/me/spaces/SPACE/spaceNotificationSetting.
        • L'adresse e-mail Workspace de l'utilisateur appelant. Par exemple, users/user@example.com/spaces/SPACE/spaceNotificationSetting.
        • L'ID utilisateur de l'utilisateur appelant. Par exemple, users/USER/spaces/SPACE/spaceNotificationSetting.
      • notificationSetting : définit le niveau de notification, par exemple ALL ou OFF.
      • muteSetting : active ou désactive le mode silencieux. Les valeurs peuvent être MUTED ou UNMUTED.
    • updateMask: définit les champs de mise à jour. Il peut inclure notification_setting et mute_setting.

L'exemple suivant modifie les paramètres de notification d'un espace de l'utilisateur appelant :

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

Pour exécuter cet exemple, remplacez SPACE_NAME par l'ID de l'espace's name. Vous pouvez obtenir l'ID en appelant la ListSpaces() méthode ou à partir de l'URL de l'espace.

L'API Google Chat modifie les paramètres de notification d'espace spécifiés et renvoie une instance de SpaceNotificationSetting.