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

client: Document the type of the sessionStore

Browse Source
This commit is contained in:
Richard van der Hoff
2016-06-07 23:44:12 +01:00
parent 9cb032ec44
commit 9c47400a0c
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/client.js
View File

@@ -77,7 +77,10 @@ var OLM_ALGORITHM = "m.olm.v1.curve25519-aes-sha2";
* in end-to-end crypto. If not specified, end-to-end crypto will be disabled. * in end-to-end crypto. If not specified, end-to-end crypto will be disabled.
* *
* @param {Object=} opts.sessionStore A store to be used for end-to-end crypto * @param {Object=} opts.sessionStore A store to be used for end-to-end crypto
* session data. If not specified, end-to-end crypto will be disabled. * session data. This should be a {@link
* module:store/session/webstorage~WebStorageSessionStore|WebStorageSessionStore},
* or an object implementing the same interface. If not specified,
* end-to-end crypto will be disabled.
* *
* @param {Object} opts.scheduler Optional. The scheduler to use. If not * @param {Object} opts.scheduler Optional. The scheduler to use. If not
* specified, this client will not retry requests on failure. This client * specified, this client will not retry requests on failure. This client