Namespace: patchBuilderProperties
patchBuilderProperties
Specifies operations to patch the metadata
properties of a document.
Methods
-
add(name, value) → {patchBuilder.PatchOperation}
-
Specifies a new property to add to a document's metadata.
Parameters:
Name Type Description name
string the name of the new metadata property value
the value of the new metadata property Returns:
a patch operation -
remove(name) → {patchBuilder.PatchOperation}
-
Specifies a metadata property to remove from the document's metadata.
Parameters:
Name Type Description name
string the name of the metadata property to remove Returns:
a patch operation -
replace(name, value) → {patchBuilder.PatchOperation}
-
Specifies a different value for a property in a document's metadata.
Parameters:
Name Type Description name
string the name of the existing metadata property value
the modified value of the metadata property Returns:
a patch operation