IStartClientOpts

Extended by

IStoredClientOpts

Properties

clientWellKnownPollPeriod?

optional clientWellKnownPollPeriod?: number

The number of seconds between polls to /.well-known/matrix/client, undefined to disable. This should be in the order of hours. Default: undefined.

disablePresence?

optional disablePresence?: boolean

Defined in: src/client.ts:520

True to perform syncing without automatically updating presence.

filter?

optional filter?: Filter

Defined in: src/client.ts:515

The filter to apply to /sync calls.

includeArchivedRooms?

optional includeArchivedRooms?: boolean

Defined in: src/client.ts:492

True to put archived=true</code> on the <code>/initialSync request. Default: false.

initialSyncLimit?

optional initialSyncLimit?: number

Defined in: src/client.ts:487

The event limit= to apply to initial sync. Default: 8.

lazyLoadMembers?

optional lazyLoadMembers?: boolean

Defined in: src/client.ts:526

True 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.

pendingEventOrdering?

optional pendingEventOrdering?: PendingEventOrdering

Defined in: src/client.ts:505

Controls 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, accessible via Room#getPendingEvents. Default: “chronological”.

pollTimeout?

optional pollTimeout?: number

Defined in: src/client.ts:510

The number of milliseconds to wait on /sync. Default: 30000 (30 seconds).

resolveInvitesToProfiles?

optional resolveInvitesToProfiles?: boolean

Defined in: src/client.ts:497

True to do /profile requests on every invite event if the displayname/avatar_url is not known for this user ID. Default: false.

slidingSync?

optional slidingSync?: SlidingSync

Defined in: src/client.ts:543

threadSupport?

optional threadSupport?: boolean

Defined in: src/client.ts:538

Will organises events in threaded conversations when a thread relation is encountered

unstableMSC4429SyncUserProfileFields?

optional unstableMSC4429SyncUserProfileFields?: string[]

Defined in: src/client.ts:549

Include user profiles in sync responses. Will only work if the server supports MSC4429.