Just doc with the MatrixClientCreds object

pull/21833/head
David Baker 2016-08-03 16:31:42 +01:00
parent a5384d32e2
commit b95a1c4a4b
1 changed files with 1 additions and 5 deletions

View File

@ -23,11 +23,7 @@ import utils from 'matrix-js-sdk/lib/utils';
/**
* Transitions to a logged-in state using the given credentials
* @param {string} credentials.homeserverUrl The base HS URL
* @param {string} credentials.identityServerUrl The base IS URL
* @param {string} credentials.userId The full Matrix User ID
* @param {string} credentials.accessToken The session access token
* @param {boolean} credentials.guest True if the session is a guest session
* @param {MatrixClientCreds} credentials The credentials to use
*/
function setLoggedIn(credentials) {
credentials.guest = Boolean(credentials.guest);