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

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

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

Prérequis

Node.js

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

Pour mettre à jour le paramètre de notification d'un espace pour un utilisateur, incluez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application de l'autorisation chat.users.spacesettings.
  • Appelez la méthode UpdateSpaceNotificationSetting() en transmettant la requête UpdateSpaceNotificationSetting contenant 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 de l'espace à mettre à jour, y compris un ID utilisateur ou un alias, ainsi qu'un ID d'espace. La mise à jour des paramètres de notification de l'espace n'est compatible qu'avec la mise à jour des paramètres de notification de l'utilisateur appelant, qui peut être spécifiée en définissant l'un des éléments suivants :
        • Alias me. Exemple : users/me/spaces/SPACE/spaceNotificationSetting.
        • Adresse e-mail Workspace de l'utilisateur appelant. Par exemple, users/user@example.com/spaces/SPACE/spaceNotificationSetting.
        • ID utilisateur de l'appelant. Par exemple, users/USER/spaces/SPACE/spaceNotificationSetting.
      • notificationSetting: définit le niveau de notification, par exemple ALL, OFF.
      • muteSetting: active ou désactive le mode silencieux. Les valeurs possibles sont MUTED ou UNMUTED.
    • updateMask: définit les champs de mise à jour. Il peut inclure notification_setting et mute_setting.

L'exemple suivant met à jour le paramètre de notification de l'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);
}

main().catch(console.error);

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

L'API Google Chat met à jour les paramètres de notification de l'espace spécifié et renvoie une instance de SpaceNotificationSetting.