From 3c246a97e8c7eb6e6ee20a51bad908f36d91a4c5 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Thu, 2 Mar 2017 14:15:43 +0000
Subject: [PATCH] More docs

---
 src/interactive-auth.js | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/interactive-auth.js b/src/interactive-auth.js
index 63595235a..7474815dc 100644
--- a/src/interactive-auth.js
+++ b/src/interactive-auth.js
@@ -165,6 +165,12 @@ InteractiveAuth.prototype = {
         return this._data ? this._data.session : undefined;
     },
 
+    /**
+     * get the client secret used for validation sessions
+     * with the ID server.
+     *
+     * @return {string} client secret
+     */
     getClientSecret: function() {
         return this._clientSecret;
     },
@@ -209,6 +215,12 @@ InteractiveAuth.prototype = {
         this._doRequest(auth, ignoreFailure);
     },
 
+    /**
+     * Sets the sid for the email validation session
+     * This must be set in order to successfully poll for completion
+     * of the email validation.
+     * Specific to m.login.email.identity
+     */
     setEmailSid: function(sid) {
         this._emailSid = sid;
     },