Namespace: patchBuilderMetadataValues
patchBuilderMetadataValues
Specifies operations to patch the metadata
values of a document.
- Since:
-
- 2.0.1
Methods
-
-
add(name, value) → {patchBuilder.PatchOperation}
-
Specifies a new metadata value to add to a document.
Parameters:
Name Type Description namestring the name of the new metadata value valuethe value of the new metadata value - Since:
-
- 2.0.1
Returns:
a patch operation -
-
remove(name) → {patchBuilder.PatchOperation}
-
Specifies a metadata value to remove from the document.
Parameters:
Name Type Description namestring the name of the metadata value to remove - Since:
-
- 2.0.1
Returns:
a patch operation -
-
replace(name, value) → {patchBuilder.PatchOperation}
-
Specifies a metadata value to replace for a document.
Parameters:
Name Type Description namestring the name of the existing metadata value valuethe modified value - Since:
-
- 2.0.1
Returns:
a patch operation