Google Chat V1 API - Class Google::Apps::Chat::V1::UpdateSpaceReadStateRequest (v0.3.1)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::UpdateSpaceReadStateRequest.

Request message for UpdateSpaceReadState API.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#space_read_state

def space_read_state() -> ::Google::Apps::Chat::V1::SpaceReadState
Returns
  • (::Google::Apps::Chat::V1::SpaceReadState) — 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

#space_read_state=

def space_read_state=(value) -> ::Google::Apps::Chat::V1::SpaceReadState
Parameter
  • value (::Google::Apps::Chat::V1::SpaceReadState) — 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

Returns
  • (::Google::Apps::Chat::V1::SpaceReadState) — 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

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — 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.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — 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.

Returns
  • (::Google::Protobuf::FieldMask) — 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.