matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-29 16:43:09 +03:00
Code Activity

Implement API for username availability (#432)

Browse Source 
Requires synapse with https://github.com/matrix-org/synapse/pull/2183, https://github.com/matrix-org/synapse/pull/2209 and https://github.com/matrix-org/synapse/pull/2213
This commit is contained in:
Luke Barnard
2017-05-11 09:14:45 +01:00
committed by GitHub
parent 6021c1c6b1
commit cb9a9e8d50
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/base-apis.js
View File

@@ -120,6 +120,20 @@ MatrixBaseApis.prototype.makeTxnId = function() {
// Registration/Login operations // Registration/Login operations
// ============================= // =============================
/**
* Check whether a username is available prior to registration. An error response
* indicates an invalid/unavailable username.
* @param {string} username The username to check the availability of.
* @return {module:client.Promise} Resolves: to `true`.
*/
MatrixBaseApis.prototype.isUsernameAvailable = function(username) {
return this._http.authedRequest(
undefined, "GET", '/register/available', { username: username },
).then((response) => {
return response.available;
});
};
/** /**
* @param {string} username * @param {string} username
* @param {string} password * @param {string} password