Update a user's space read state (original) (raw)

This guide explains how to use theupdate()method on the SpaceReadState resource of the Google Chat API to mark spaces as read or unread.

TheSpaceReadState resourceis a singleton resource that represents details about a specified user's last read message in a Google Chat space.

Prerequisites

Node.js

• A Business or EnterpriseGoogle Workspace account with access toGoogle Chat.
• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Node.js Cloud Client Library.
  • Create OAuth client ID credentials for a desktop application. To run the sample in this guide, save the credentials as a JSON file named credentials.json to your local directory.
    For guidance, complete the steps for setting up your environment in this[quickstart](/workspace/chat/api/guides/quickstart/nodejs

#set-up-environment).

• Choose an authorization scope that supports user authentication.

Update the calling user's space read state

To update a user's read state within a space, include the following in your request:

• Specify the chat.users.readstate authorization scope.
• Call theUpdateSpaceReadState()method.
• Pass updateMask with the value lastReadTime.
• Pass spaceReadState as an instance ofSpaceReadStatewith the following:
  • The name field set to the space read state to update, which includes a user ID or alias and a space ID. Updating space read state only supports updating the read state of the calling user, which can be specified by setting one of the following:
    * The me alias. For example,users/me/spaces/SPACE/spaceReadState.
    * The calling user's Workspace email address. For example,users/user@example.com/spaces/SPACE/spaceReadState.
    * The calling user's user ID. For example,users/USER/spaces/SPACE/spaceReadState.
  • The lastReadTime field set to the updated value of the time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space. When the lastReadTime is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set lastReadTime to any value later (larger) than the latest message create time. The lastReadTime is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.

The following example updates the calling user's space read state:

Node.js

To run this sample, replace SPACE_NAME with the ID from the space'sname. You can obtain the ID by calling theListSpaces()method or from the space's URL.

The Google Chat API updates the specified space read state and returns an instance ofSpaceReadState.

• Get the calling user's space read state.
• Get the calling user's thread read state.