You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-11-28 05:03:59 +03:00
Review comments
This commit is contained in:
@@ -2733,10 +2733,10 @@ MatrixClient.prototype.getTurnServers = function() {
|
||||
|
||||
|
||||
/**
|
||||
* High level helper method to call initialSync, emit the resulting events,
|
||||
* and then start polling the eventStream for new events. To listen for these
|
||||
* High level helper method to begin syncing and poll for new events. To listen for these
|
||||
* events, add a listener for {@link module:client~MatrixClient#event:"event"}
|
||||
* via {@link module:client~MatrixClient#on}.
|
||||
* via {@link module:client~MatrixClient#on}. Alternatively, listen for specific
|
||||
* state change events.
|
||||
* @param {Object=} opts Options to apply when syncing.
|
||||
* @param {Number=} opts.initialSyncLimit The event <code>limit=</code> to apply
|
||||
* to initial sync. Default: 8.
|
||||
@@ -2753,11 +2753,18 @@ MatrixClient.prototype.getTurnServers = function() {
|
||||
* accessbile via {@link module:models/room#getPendingEvents}. Default:
|
||||
* "chronological".
|
||||
*
|
||||
* @param {Number=} opts.pollTimeout The number of milliseconds to wait on /events.
|
||||
* @param {Number=} opts.pollTimeout The number of milliseconds to wait on /sync.
|
||||
* Default: 30000 (30 seconds).
|
||||
*
|
||||
* @param {Filter=} opts.filter The filter to apply to /sync calls. This will override
|
||||
* the opts.initialSyncLimit, which would normally result in a timeline limit filter.
|
||||
*
|
||||
* @param {Function=} opts.canResetEntireTimeline A function which is called when /sync
|
||||
* returns a 'limited' response. It is called with a room ID and returns a boolean.
|
||||
* It should return 'true' if the SDK can SAFELY remove events from this room. It may
|
||||
* not be safe to remove events if there are other references to the timelines for this
|
||||
* room, e.g because the client is actively viewing events in this room.
|
||||
* Default: returns false.
|
||||
*/
|
||||
MatrixClient.prototype.startClient = function(opts) {
|
||||
if (this.clientRunning) {
|
||||
|
||||
Reference in New Issue
Block a user