Fix Tos Module

[friendica.git] / doc / Addons.md

diff --git a/doc/Addons.md b/doc/Addons.md
index 230e9e93b96910688df22412c4e0095d02feaa35..708a2e0f045b80b69599dba4f92f6b33e3b1c719 100644 (file)
--- a/doc/Addons.md
+++ b/doc/Addons.md
@@ -477,7 +477,18 @@ Hook data:
 - **uri** (input): the profile URI.
 - **network** (input): the target network (can be empty for auto-detection).
 - **uid** (input): the user to return the contact data for (can be empty for public contacts).
-- **result** (output): Set by the hook function to indicate a successful detection.
+- **result** (output): Leave null if address isn't relevant to the connector, set to contact array if probe is successful, false otherwise.
+
+### item_by_link
+
+Called when trying to probe an item from a given URI.
+If any registered hook function sets the `item_id` key of the hook data array, it will be returned immediately.
+Hook functions should also return immediately if the hook data contains an existing `item_id`.
+
+Hook data:
+- **uri** (input): the item URI.
+- **uid** (input): the user to return the item data for (can be empty for public contacts).
+- **item_id** (output): Leave null if URI isn't relevant to the connector, set to created item array if probe is successful, false otherwise.
 
 ### support_follow