Document login API

This commit is contained in:
Luke Barnard 2017-02-07 12:01:44 +00:00
parent 4f3549cc37
commit af19ea8bb7

View file

@ -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',
{