From 6d15c259b41def059950560c732ce537600ba9c1 Mon Sep 17 00:00:00 2001
From: Skylar Sadlier <skylord123@gmail.com>
Date: Mon, 30 Aug 2021 09:50:13 -0600
Subject: [PATCH] - Update documentation for matrix-room-users and
 matrix-synapse-create-edit-user - matrix-synapse-deactivate-user fixed

---
 src/matrix-room-users.html               | 15 ++++++++-------
 src/matrix-synapse-create-edit-user.html |  6 +++---
 src/matrix-synapse-deactivate-user.js    |  5 +----
 3 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/src/matrix-room-users.html b/src/matrix-room-users.html
index bc59d12..eb9fcbf 100644
--- a/src/matrix-room-users.html
+++ b/src/matrix-room-users.html
@@ -38,7 +38,8 @@
 
 <script type="text/html" data-help-name="matrix-room-users">
     <h3>Details</h3>
-    <p>List out joined users from a Matrix room.</p>
+    <p>A list of members of the room. If you are joined to the room then this will be the current members of the room. If you have left the room then this will be the members of the room when you left.</p>
+    <a href="https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-rooms-roomid-joined-members" target="_blank">Matrix API Endpoint Information</a>
 
     <h3>Inputs</h3>
     <dl class="message-properties">
@@ -55,14 +56,14 @@
                 <dt>msg.payload <span class="property-type">object</span></dt>
                 <dd>the response object from the server.</dd>
 
-                <dt>msg.payload.users <span class="property-type">array</span></dt>
-                <dd>list of users from the Matrix server. <a href="https://matrix-org.github.io/synapse/develop/admin_api/user_admin_api.html#list-accounts" target="_blank">Click here</a> for details on what this contains (or do a test and dump the output). We would put the details here in the doc but Synapse is constantly changing so it's best to reference the official Synapse docs.</dd>
+                <dt>msg.payload.joined <span class="property-type">object</span></dt>
+                <dd>A map from user ID to a RoomMember object. The key of each item is the <code>userId</code>. <a href="https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-rooms-roomid-joined-members" target="_blank">Click here</a> for details on what this contains (or do a test and dump the output).</dd>
 
-                <dt>msg.next_token <span class="property-type">string</span></dt>
-                <dd>string representing a positive integer - Indication for pagination. See above (input msg.from)</dd>
+                <dt>msg.payload.joined.[userId].display_name <span class="property-type">string</span></dt>
+                <dd>The display name of the user this object is representing.</dd>
 
-                <dt>msg.total <span class="property-type">integer</span></dt>
-                <dd>Total number of media.</dd>
+                <dt>msg.payload.joined.[userId].avatar_url <span class="property-type">string</span></dt>
+                <dd>The mxc avatar url of the user this object is representing.</dd>
             </dl>
         </li>
         <li>Error
diff --git a/src/matrix-synapse-create-edit-user.html b/src/matrix-synapse-create-edit-user.html
index 02367a0..b9fd97e 100644
--- a/src/matrix-synapse-create-edit-user.html
+++ b/src/matrix-synapse-create-edit-user.html
@@ -35,7 +35,7 @@
 
 <script type="text/html" data-help-name="matrix-synapse-create-edit-user">
     <h3>Details</h3>
-    <p>Add a new user to a Synapse Matrix server. This is only supported on Synapse servers and the API client must be an admin.</p>
+    <p>Allows an administrator to create or modify a user account with a specific <code>msg.userId</code>.</p>
     <a href="https://matrix-org.github.io/synapse/develop/admin_api/user_admin_api.html#create-or-modify-account" target="_blank">Synapse API Endpoint Information</a>
 
     <h3>Inputs</h3>
@@ -48,7 +48,7 @@
         <dt>msg.payload
             <span class="property-type">Object</span>
         </dt>
-        <dd> Details of the new user to create. <a href="https://matrix-org.github.io/synapse/develop/admin_api/user_admin_api.html#create-or-modify-account" target="_blank">Click here</a> to see what valid data you can pass via this input.</dd>
+        <dd> Details of the new user to create. <a href="https://matrix-org.github.io/synapse/develop/admin_api/user_admin_api.html#create-or-modify-account" target="_blank">Click here</a> to see what valid data you can pass via this input. If the user already exists then optional parameters default to the current value.</dd>
     </dl>
 
     <h3>Outputs</h3>
@@ -57,7 +57,7 @@
             <dl class="message-properties">
                 <dd>original msg object preserved.</dd>
 
-                <dt>msg.eventId <span class="property-type">string</span></dt>
+                <dt>msg.payload <span class="property-type">string</span></dt>
                 <dd>the eventId from the posted message.</dd>
             </dl>
         </li>
diff --git a/src/matrix-synapse-deactivate-user.js b/src/matrix-synapse-deactivate-user.js
index bbe47d8..5597805 100644
--- a/src/matrix-synapse-deactivate-user.js
+++ b/src/matrix-synapse-deactivate-user.js
@@ -52,7 +52,7 @@ module.exports = function(RED) {
 
             const path = node.encodeUri(
                 "/_synapse/admin/v1/deactivate/$userId",
-                { $userId: userId },
+                { $userId: msg.userId },
             );
             node.server.matrixClient.http
                 .authedRequest(undefined, 'POST', path, undefined, { "erase": (msg.erase || false) }, { prefix: '' })
@@ -64,9 +64,6 @@ module.exports = function(RED) {
                     msg.error = e;
                     node.send([null, msg]);
                 });
-
-            node.server.matrixClient.deactivateSynapseUser(msg.userId)
-                ;
         });
     }
     RED.nodes.registerType("matrix-synapse-deactivate-user", MatrixSynapseDeactivateUser);