Interface UpdateSpaceReadStateRequestOrBuilder (0.12.0) 

public interface UpdateSpaceReadStateRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSpaceReadState()

public abstract SpaceReadState getSpaceReadState()

Required. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

  • The me alias. For example, users/me/spaces/{space}/spaceReadState.

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

    Format: users/{user}/spaces/{space}/spaceReadState

.google.chat.v1.SpaceReadState space_read_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpaceReadState

The spaceReadState.

getSpaceReadStateOrBuilder()

public abstract SpaceReadStateOrBuilder getSpaceReadStateOrBuilder()

Required. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

  • The me alias. For example, users/me/spaces/{space}/spaceReadState.

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

    Format: users/{user}/spaces/{space}/spaceReadState

.google.chat.v1.SpaceReadState space_read_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpaceReadStateOrBuilder

getUpdateMask()

public abstract FieldMask getUpdateMask()

Required. The field paths to update. Currently supported field paths:

  • last_read_time

    When the last_read_time is before the latest message create time, the space appears as unread in the UI.

    To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time 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.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. The field paths to update. Currently supported field paths:

  • last_read_time

    When the last_read_time is before the latest message create time, the space appears as unread in the UI.

    To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time 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.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMaskOrBuilder

hasSpaceReadState()

public abstract boolean hasSpaceReadState()

Required. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

  • The me alias. For example, users/me/spaces/{space}/spaceReadState.

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

    Format: users/{user}/spaces/{space}/spaceReadState

.google.chat.v1.SpaceReadState space_read_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the spaceReadState field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

Required. The field paths to update. Currently supported field paths:

  • last_read_time

    When the last_read_time is before the latest message create time, the space appears as unread in the UI.

    To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time 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.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the updateMask field is set.