matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00
Code Activity

Appease the js-doc

Browse Source
This commit is contained in:
Travis Ralston
2019-08-21 14:17:55 -06:00
parent 8a0ddc43ab
commit 241811298f
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/base-apis.js
View File

@@ -1860,7 +1860,7 @@ MatrixBaseApis.prototype.submitMsisdnToken = async function(
/** /**
* Gets the V2 hashing information from the identity server. Primarily useful for * Gets the V2 hashing information from the identity server. Primarily useful for
* lookups. * lookups.
* @param identityAccessToken The access token for the identity server. * @param {string} identityAccessToken The access token for the identity server.
* @returns {Promise<object>} The hashing information for the identity server. * @returns {Promise<object>} The hashing information for the identity server.
*/ */
MatrixBaseApis.prototype.getIdentityHashDetails = function(identityAccessToken) { MatrixBaseApis.prototype.getIdentityHashDetails = function(identityAccessToken) {
@@ -1873,10 +1873,10 @@ MatrixBaseApis.prototype.getIdentityHashDetails = function(identityAccessToken)
/** /**
* Performs a hashed lookup of addresses against the identity server. This is * Performs a hashed lookup of addresses against the identity server. This is
* only supported on identity servers which have at least the version 2 API. * only supported on identity servers which have at least the version 2 API.
* @param addressPairs An array of 2 element arrays. The first element of each * @param {Array<Array<string,string>>} addressPairs An array of 2 element arrays.
* pair is the address, the second is the 3PID medium. Eg: ["email@example.org", * The first element of each pair is the address, the second is the 3PID medium.
* "email"] * Eg: ["email@example.org", "email"]
* @param identityAccessToken The access token for the identity server. * @param {string} identityAccessToken The access token for the identity server.
* @returns {Promise<{address, mxid}[]>} A collection of address mappings to * @returns {Promise<{address, mxid}[]>} A collection of address mappings to
* found MXIDs. Results where no user could be found will not be listed. * found MXIDs. Results where no user could be found will not be listed.
*/ */