chattolib/proto/chatto/api/v1/read_state.proto

syntax = "proto3";

package chatto.api.v1;

import "buf/validate/validate.proto";
import "google/protobuf/timestamp.proto";

// Request to mark a room timeline as read.
message MarkRoomAsReadRequest {
  // Required. Room whose timeline should be marked read.
  string room_id = 1 [(buf.validate.field).string.min_len = 1];
  // Highest room event ID the current user has read. When set, the event must
  // exist as a root event in the room timeline. Leave empty to mark through the
  // room's current latest root event.
  string up_to_event_id = 2;
}

// Result of marking a room timeline as read.
//
// Clients can use the previous timestamp to decide whether unread badges or
// local notification state need to be reconciled.
message MarkRoomAsReadResponse {
  // New room read timestamp stored for the current user.
  google.protobuf.Timestamp last_read_at = 1;
  // Previous room read timestamp, when one existed.
  google.protobuf.Timestamp previous_last_read_at = 2;
}

// Request to mark a message thread as read.
message MarkThreadAsReadRequest {
  // Required. Room containing the thread.
  string room_id = 1 [(buf.validate.field).string.min_len = 1];
  // Required. Event ID of the root message for the thread.
  string thread_root_event_id = 2 [(buf.validate.field).string.min_len = 1];
  // Highest thread event ID the current user has read. The event should belong
  // to the thread identified by thread_root_event_id.
  string up_to_event_id = 3;
}

// Result of marking a message thread as read.
message MarkThreadAsReadResponse {
  // Previous thread read timestamp, when one existed.
  google.protobuf.Timestamp previous_read_at = 1;
}