PatchChange

Reports a completed change back to Lucid

---

Constructors

new PatchChange()

ts

new PatchChange(
   patchId, 
   syncId, 
   collections, 
   creationPermission?): PatchChange

Parameters

Parameter	Type
patchId	string
syncId	string
collections	PatchChangeCollection[]
creationPermission?	"DataSource" | "Collection" | "Item" | "None"

Returns

PatchChange

---

Properties

collections

ts

collections: PatchChangeCollection[];

---

creationPermission?

ts

optional creationPermission: "DataSource" | "Collection" | "Item" | "None";

---

patchId

ts

patchId: string;

---

syncId

ts

syncId: string;

---

Methods

getErrors()

ts

getErrors(): Record<string, Record<string, DetailedPatchError>>

Returns

Record<string, Record<string, DetailedPatchError>>

---

setError()

ts

setError(
   primaryKey, 
   fieldName, 
   error, 
   type): void

Parameters

Parameter	Type	Default value
primaryKey	string	undefined
fieldName	string	undefined
error	string	undefined
type	PatchErrorType	PatchErrorType.Default

Returns

void

Deprecated

• use setFieldErrorOrDefaultToTooltip() instead.

---

setFieldErrorOrDefaultToTooltip()

ts

setFieldErrorOrDefaultToTooltip(
   primaryKey, 
   error, 
   fieldName?, 
   type?): void

Set the error message for a specific field on a specific item. If fieldName is provided, will have field-specific
error resolution. Otherwise, will default to PatchErrorTooltipField.

Parameters

Parameter	Type	Default value
primaryKey	string	undefined
error	string	undefined
fieldName?	string	undefined
type?	PatchErrorType	PatchErrorType.Default

Returns

void

---

setTooltipError()

ts

setTooltipError(
   primaryKey, 
   error, 
   fieldName?, 
   type?): void

Parameters

Parameter	Type	Default value
primaryKey	string	undefined
error	string	undefined
fieldName?	string	undefined
type?	PatchErrorType	PatchErrorType.Default

Returns

void

Deprecated

• use setFieldErrorOrDefaultToTooltip() instead.