From af19ea8bb789bd4877f0e40125b577d7cb6ac747 Mon Sep 17 00:00:00 2001
From: Luke Barnard <lukeb@openmarket.com>
Date: Tue, 7 Feb 2017 12:01:44 +0000
Subject: [PATCH] Document login API

---
 src/RtsClient.js | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/RtsClient.js b/src/RtsClient.js
index b8b51791ba..5cf2e811ad 100644
--- a/src/RtsClient.js
+++ b/src/RtsClient.js
@@ -78,6 +78,13 @@ export default class RtsClient {
         );
     }
 
+    /**
+     * Signal to the RTS that a login has occurred and that a user requires their team's
+     * token.
+     * @param {string} userId the user ID of the user who is a member of a team.
+     * @returns {Promise} a promise that resolves to { team_token: 'sometoken' } upon
+     * success.
+     */
     login(userId) {
         return request(this._url + '/login',
             {