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

PR feedback inc doccing params

Browse Source
This commit is contained in:
David Baker
2016-07-07 11:16:50 +01:00
parent abbe9d2bc7
commit aa36571981
1 changed files with 15 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
lib/client.js
View File

@@ -2788,7 +2788,7 @@ MatrixClient.prototype.register = function(username, password,
/** /**
* Requests an email verification token for the purposes of registration. * Requests an email verification token for the purposes of registration.
* This API proxies the Identity Server /validate/email/requestToken API, * This API proxies the Identity Server /validate/email/requestToken API,
* adding registration-specific behaviour. Specifically, an account with * adding registration-specific behaviour. Specifically, if an account with
* the given email address already exists, it will either send an email * the given email address already exists, it will either send an email
* to the address informing them of this or return M_THREEPID_IN_USE * to the address informing them of this or return M_THREEPID_IN_USE
* (which one is up to the Home Server). * (which one is up to the Home Server).
@@ -2796,17 +2796,14 @@ MatrixClient.prototype.register = function(username, password,
* requestEmailToken calls the equivalent API directly on the ID server, * requestEmailToken calls the equivalent API directly on the ID server,
* therefore bypassing the registration-specific logic. * therefore bypassing the registration-specific logic.
* *
* @param {string} email * Parameters and return value are as for requestEmailToken
* @param {string} clientSecret
* @param {string} sendAttempt
* @param {string} nextLink Optional
* @param {module:client.callback} callback Optional.
* @return {module:client.Promise} Resolves: TODO
* @return {module:http-api.MatrixError} Rejects: with an error response.
*/ */
MatrixClient.prototype.requestRegisterEmailToken = function(email, clientSecret, MatrixClient.prototype.requestRegisterEmailToken = function(email, clientSecret,
sendAttempt, nextLink, callback) { sendAttempt, nextLink, callback) {
var id_server_url = url.parse(this.idBaseUrl); var id_server_url = url.parse(this.idBaseUrl);
if (id_server_url.host == null) {
throw new Error("Invalid ID server URL: " + this.idBaseUrl);
}
var params = { var params = {
client_secret: clientSecret, client_secret: clientSecret,
@@ -3707,13 +3704,19 @@ MatrixClient.prototype.getEventMapper = function() {
* Note that the Home Server offers APIs to proxy this API for specific * Note that the Home Server offers APIs to proxy this API for specific
* situations, allowing for better feedback to the user. * situations, allowing for better feedback to the user.
* *
* @param {string} email * @param {string} email The email address to request a token for
* @param {string} clientSecret * @param {string} clientSecret A secret binary string generated by the client.
* @param {string} sendAttempt * It is recommended this be around 16 ASCII characters.
* @param {string} nextLink Optional * @param {number} sendAttempt If an identity server sees a duplicate request
* with the same sendAttempt, it will not send another email.
* To request another email to be sent, use a larger value for
* the sendAttempt param as was used in the previous request.
* @param {string} nextLink Optional If specified, the client will be redirected
* to this link after validation.
* @param {module:client.callback} callback Optional. * @param {module:client.callback} callback Optional.
* @return {module:client.Promise} Resolves: TODO * @return {module:client.Promise} Resolves: TODO
* @return {module:http-api.MatrixError} Rejects: with an error response. * @return {module:http-api.MatrixError} Rejects: with an error response.
* @throws Error if No ID server is set
*/ */
MatrixClient.prototype.requestEmailToken = function(email, clientSecret, MatrixClient.prototype.requestEmailToken = function(email, clientSecret,
sendAttempt, nextLink, callback) { sendAttempt, nextLink, callback) {