Sanity Library Reference Docs
    Preparing search index...

    Type Alias CollaborationCommentUpdateAlpha

    CollaborationCommentUpdate: {
        message?: CollaborationCommentMessage;
        status?: CollaborationCommentStatus;
    } & (
        | {
            anchor: CollaborationCommentAnchor;
            fieldValue?: never;
            range?: never;
        }
        | { anchor: null; fieldValue?: never; range?: never }
        | {
            anchor?: never;
            fieldValue?: CollaborationCommentFieldValue;
            range: CollaborationCommentRange;
        }
        | { anchor?: never; fieldValue?: never; range: null }
        | { anchor?: undefined; fieldValue?: never; range?: undefined }
    )

    Fields that can be updated on an existing comment.

    An anchor re-anchors the comment within the field it already targets. Pass null to remove the selection and leave a field-level comment. An optional fieldValue on a portable-text anchor is resolved from those blocks instead of from the live document.

    Deprecated range + top-level fieldValue (and range: null) are still accepted and converted to anchor before the request is sent.

    Type declaration

    • { anchor: CollaborationCommentAnchor; fieldValue?: never; range?: never }
      • anchor: CollaborationCommentAnchor
      • OptionalfieldValue?: never

        Use anchor.fieldValue.

      • Optionalrange?: never

        Use anchor.

    • { anchor: null; fieldValue?: never; range?: never }
      • anchor: null
      • OptionalfieldValue?: never

        Use anchor.fieldValue.

      • Optionalrange?: never

        Use anchor.

    • {
          anchor?: never;
          fieldValue?: CollaborationCommentFieldValue;
          range: CollaborationCommentRange;
      }
      • Optionalanchor?: never
      • OptionalfieldValue?: CollaborationCommentFieldValue

        Portable Text covering the range. When set, the selection is resolved from these blocks instead of from the live document.

        Use anchor.fieldValue.

      • range: CollaborationCommentRange

        Use anchor.

    • { anchor?: never; fieldValue?: never; range: null }
      • Optionalanchor?: never
      • OptionalfieldValue?: never

        Use anchor.fieldValue.

      • range: null

        Use anchor: null.

    • { anchor?: undefined; fieldValue?: never; range?: undefined }
      • Optionalanchor?: undefined
      • OptionalfieldValue?: never

        Use anchor.fieldValue.

      • Optionalrange?: undefined

        Use anchor.

    Settings

    Member Visibility