Optional
clientThe number of seconds between polls to /.well-known/matrix/client, undefined to disable. This should be in the order of hours. Default: undefined.
Optional
cryptoOptional
disableTrue to perform syncing without automatically updating presence.
Optional
Experimental
experimentalOptional
filterThe filter to apply to /sync calls.
Optional
includeTrue to put archived=true</code> on the <code>/initialSync
request. Default: false.
Optional
initialThe event limit=
to apply to initial sync. Default: 8.
Optional
lazyTrue to not load all membership events during initial sync but fetch them when needed by calling
loadOutOfBandMembers
This will override the filter option at this moment.
Optional
pendingControls where pending messages appear in a room's timeline. If "chronological", messages will
appear in the timeline when the call to sendEvent
was made. If "detached",
pending messages will appear in a separate list, accessbile via getPendingEvents.
Default: "chronological".
Optional
pollThe number of milliseconds to wait on /sync. Default: 30000 (30 seconds).
Optional
resolveTrue to do /profile requests on every invite event if the displayname/avatar_url is not known for this user ID. Default: false.
Optional
Experimental
slidingGenerated using TypeDoc
A function which 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.