Skip to content

Commit b7c4555

Browse files
author
Farzad Hayatbakhsh
committed
Admonition about known limitation of mentionedUids user validation
1 parent fe5942f commit b7c4555

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

modules/ROOT/partials/plugin-apis/comments-apis.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@ When the xref:mentions.adoc[Mentions] plugin is enabled, each of the above event
118118

119119
It is recommended to use this API to retrieve which users have been mentioned in comments.
120120

121+
[NOTE]
122+
====
123+
The `mentionedUids` array captures any string following the `@` symbol without verifying if these strings correspond to valid user IDs. It is up to the developer to ensure that the mentioned users are valid users in the database. Refer to the xref:#example-using-geteventlog[getEventLog example] for an example of how to retrieve and verify the `mentionedUids` array.
124+
====
125+
126+
[[example-using-geteventlog]]
121127
==== Example: using `+getEventLog()+`
122128

123129
[source,js]

0 commit comments

Comments
 (0)