summaryrefslogtreecommitdiffstats
path: root/Documentation/pg-plugin-change-metadata-api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/pg-plugin-change-metadata-api.txt')
-rw-r--r--Documentation/pg-plugin-change-metadata-api.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/pg-plugin-change-metadata-api.txt b/Documentation/pg-plugin-change-metadata-api.txt
new file mode 100644
index 0000000000..8348da80a1
--- /dev/null
+++ b/Documentation/pg-plugin-change-metadata-api.txt
@@ -0,0 +1,16 @@
+= Gerrit Code Review - Change metadata plugin API
+
+This API is provided by
+link:pg-plugin-dev.html#change-metadata[plugin.changeMetadata()] and provides
+interface for customization and data updates of change metadata.
+
+== onLabelsChanged
+`changeMetadataApi.onLabelsChanged(callback)`
+
+.Params
+- *callback* function that's executed when labels changed on the server.
+Callback receives labels with scores applied to the change, map of the label
+names to link:rest-api-changes.html#label-info[LabelInfo] entries
+
+.Returns
+- `GrChangeMetadataApi` for chaining.