CommentThread | @sheetwrite/core

Versioned discussion anchored to a document location.

Package: @sheetwrite/core
Source: packages/core/src/collaboration.ts#L374

Members 8

id

id: string;

documentId

documentId: string;

anchor

anchor: CommentAnchortype CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: {
        sheet: string;
        row: number;
        col: number;
      };
    }
  | {
      kind: "range";
      range: Range;
    };Document location to which a comment thread is attached.API reference →;

version

version: number;

messages

messages: readonly CommentMessageinterface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}interface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}interface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}One immutable author message in a comment thread.API reference →[];

resolved

resolved: boolean;

resolvedBy

resolvedBy?: CommentAuthorRefinterface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}interface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}interface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}Stable host-provided identity displayed on a comment message.API reference →;

resolvedAt

resolvedAt?: string;

Declaration

View full TypeScript declaration

export interface CommentThread {
  id: string;
  documentId: string;
  anchor: CommentAnchortype CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: { sheet: string; row: number; col: number };
    }
  | { kind: "range"; range: Range };type CommentAnchor =
  | {
      kind: "cell";
      address: {
        sheet: string;
        row: number;
        col: number;
      };
    }
  | {
      kind: "range";
      range: Range;
    };Document location to which a comment thread is attached.API reference →;
  version: number;
  messages: readonly CommentMessageinterface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}interface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}interface CommentMessage {
  id: string;
  author: CommentAuthorRef;
  body: string;
  createdAt: string;
  editedAt?: string;
}One immutable author message in a comment thread.API reference →[];
  resolved: boolean;
  resolvedBy?: CommentAuthorRefinterface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}interface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}interface CommentAuthorRef {
  id: string;
  displayName?: string;
  avatarUrl?: string;
}Stable host-provided identity displayed on a comment message.API reference →;
  resolvedAt?: string;
}