Sanity Library Reference Docs
    Preparing search index...

    Type Alias CollaborationCommentUpdateAlpha

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

    Fields that can be updated on an existing comment.

    A range 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 is Portable Text covering that range; when set, the range is resolved from those blocks instead of from the live document. fieldValue cannot be sent alone or together with range: null.

    Type declaration

    Settings

    Member Visibility