CommentMutationRequest | @sheetwrite/core

Versioned comment mutation submitted to a host adapter.

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

Members 5

documentId

documentId: string;

baseVersion

baseVersion: number;

clientMutationId

clientMutationId: string;

mutation

mutation: CommentMutationtype CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | { kind: "resolve"; threadId: string; resolved: boolean };type CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | { kind: "resolve"; threadId: string; resolved: boolean };type CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | {
      kind: "resolve";
      threadId: string;
      resolved: boolean;
    };Serializable operation that creates or updates comment state.API reference →;

signal

signal?: AbortSignal;

Declaration

View full TypeScript declaration

export interface CommentMutationRequest {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  mutation: CommentMutationtype CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | { kind: "resolve"; threadId: string; resolved: boolean };type CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | { kind: "resolve"; threadId: string; resolved: boolean };type CommentMutation =
  | {
      kind: "create";
      threadId: string;
      messageId: string;
      anchor: CommentAnchor;
      body: string;
    }
  | {
      kind: "reply";
      threadId: string;
      messageId: string;
      body: string;
    }
  | {
      kind: "resolve";
      threadId: string;
      resolved: boolean;
    };Serializable operation that creates or updates comment state.API reference →;
  signal?: AbortSignal;
}