REST Resource: users.spaces.spaceNotificationSetting
Stay organized with collections
Save and categorize content based on your preferences.
Resource: SpaceNotificationSetting
The notification setting of a user in a space.
Fields |
name |
string
Identifier. The resource name of the space notification setting. Format: users/{user}/spaces/{space}/spaceNotificationSetting .
|
notificationSetting |
enum (NotificationSetting )
The notification setting.
|
muteSetting |
enum (MuteSetting )
The space notification mute setting.
|
NotificationSetting
The notification setting types. Other types might be supported in the future.
Enums |
NOTIFICATION_SETTING_UNSPECIFIED |
Reserved. |
ALL |
Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user. |
MAIN_CONVERSATIONS |
The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages. |
FOR_YOU |
The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages. |
OFF |
Notification is off. |
MuteSetting
The space notification mute setting types.
Enums |
MUTE_SETTING_UNSPECIFIED |
Reserved. |
UNMUTED |
The user will receive notifications for the space based on the notification setting. |
MUTED |
The user will not receive any notifications for the space, regardless of the notification setting. |
Methods |
|
Gets the space notification setting. |
|
Updates the space notification setting. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eSpaceNotificationSetting allows you to manage a user's notification settings within a Google Chat space.\u003c/p\u003e\n"],["\u003cp\u003eYou can configure notification triggers for various events like @mentions, new threads, and followed threads using NotificationSetting.\u003c/p\u003e\n"],["\u003cp\u003eMuteSetting enables you to mute or unmute all notifications for a space, overriding the NotificationSetting.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is currently in Developer Preview and accessible through the Google Workspace Developer Preview Program.\u003c/p\u003e\n"],["\u003cp\u003eUse the \u003ccode\u003eget\u003c/code\u003e and \u003ccode\u003epatch\u003c/code\u003e methods to retrieve and update space notification settings respectively.\u003c/p\u003e\n"]]],["SpaceNotificationSetting defines a user's notification preferences within a space, encompassing `notificationSetting` and `muteSetting`. Notification settings include `ALL`, `MAIN_CONVERSATIONS`, `FOR_YOU`, or `OFF`, controlling when notifications are triggered. Mute settings are `UNMUTED` or `MUTED`, determining if the user gets any notifications, regardless of the notification type. Methods include `get` to retrieve the settings and `patch` to update them, available in the Google Workspace Developer Preview Program.\n"],null,["# REST Resource: users.spaces.spaceNotificationSetting\n\n- [Resource: SpaceNotificationSetting](#SpaceNotificationSetting)\n - [JSON representation](#SpaceNotificationSetting.SCHEMA_REPRESENTATION)\n- [NotificationSetting](#NotificationSetting)\n- [MuteSetting](#MuteSetting)\n- [Methods](#METHODS_SUMMARY)\n\nResource: SpaceNotificationSetting\n----------------------------------\n\nThe notification setting of a user in a space.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"notificationSetting\": enum (/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting#NotificationSetting), \"muteSetting\": enum (/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting#MuteSetting) } ``` |\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`. |\n| `notificationSetting` | `enum (`[NotificationSetting](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting#NotificationSetting)`)` The notification setting. |\n| `muteSetting` | `enum (`[MuteSetting](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting#MuteSetting)`)` The space notification mute setting. |\n\nNotificationSetting\n-------------------\n\nThe notification setting types. Other types might be supported in the future.\n\n| Enums ||\n|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `NOTIFICATION_SETTING_UNSPECIFIED` | Reserved. |\n| `ALL` | Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user. |\n| `MAIN_CONVERSATIONS` | The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages. |\n| `FOR_YOU` | The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages. |\n| `OFF` | Notification is off. |\n\nMuteSetting\n-----------\n\nThe space notification mute setting types.\n\n| Enums ||\n|----------------------------|----------------------------------------------------------------------------------------------------|\n| `MUTE_SETTING_UNSPECIFIED` | Reserved. |\n| `UNMUTED` | The user will receive notifications for the space based on the notification setting. |\n| `MUTED` | The user will not receive any notifications for the space, regardless of the notification setting. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------|-----------------------------------------|\n| ### [get](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting/get) | Gets the space notification setting. |\n| ### [patch](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting/patch) | Updates the space notification setting. |"]]