/
ILiveShareClientOptions.yml
96 lines (90 loc) · 3.32 KB
/
ILiveShareClientOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
### YamlMime:TSType
name: ILiveShareClientOptions
uid: '@microsoft/live-share.ILiveShareClientOptions'
package: '@microsoft/live-share'
summary: Options used to configure the `LiveShareClient` class.
fullName: ILiveShareClientOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: canSendBackgroundUpdates
uid: '@microsoft/live-share.ILiveShareClientOptions.canSendBackgroundUpdates'
package: '@microsoft/live-share'
summary: >-
Optional. Setting for whether `LiveDataObject` instances using
`LiveObjectSynchronizer` can send background updates.
Default value is `true`.
fullName: canSendBackgroundUpdates
remarks: >-
This is useful for scenarios where there are a large number of
participants in a session, since service performance degrades as more
socket connections are opened.
Intended for use when a small number of users are intended to be "in
control", such as the `LiveFollowMode` class's `startPresenting()`
feature.
There should always be at least one user in the session that has
`canSendBackgroundUpdates` set to true.
Set to true when the user is eligible to send background updates (e.g.,
"in control"), or false when that user is not in control.
This setting will not prevent the local user from explicitly changing the
state of objects using `LiveObjectSynchronizer`, such as `.set()` in
`LiveState`.
Impacts background updates of `LiveState`, `LivePresence`, `LiveTimer`,
and `LiveFollowMode`.
isDeprecated: false
syntax:
content: 'canSendBackgroundUpdates?: boolean'
return:
description: ''
type: boolean
- name: connection
uid: '@microsoft/live-share.ILiveShareClientOptions.connection'
package: '@microsoft/live-share'
summary: >-
Optional. Configuration to use when connecting to a custom Azure Fluid
Relay instance.
fullName: connection
remarks: ''
isDeprecated: false
syntax:
content: 'connection?: AzureRemoteConnectionConfig | AzureLocalConnectionConfig'
return:
description: ''
type: AzureRemoteConnectionConfig | AzureLocalConnectionConfig
- name: logger
uid: '@microsoft/live-share.ILiveShareClientOptions.logger'
package: '@microsoft/live-share'
summary: Optional. A logger instance to receive diagnostic messages.
fullName: logger
remarks: ''
isDeprecated: false
syntax:
content: 'logger?: ITelemetryBaseLogger'
return:
description: ''
type: ITelemetryBaseLogger
- name: roleVerifier
uid: '@microsoft/live-share.ILiveShareClientOptions.roleVerifier'
package: '@microsoft/live-share'
summary: Optional. Custom role verifier to use.
fullName: roleVerifier
remarks: ''
isDeprecated: false
syntax:
content: 'roleVerifier?: IRoleVerifier'
return:
description: ''
type: IRoleVerifier
- name: timestampProvider
uid: '@microsoft/live-share.ILiveShareClientOptions.timestampProvider'
package: '@microsoft/live-share'
summary: Optional. Custom timestamp provider to use.
fullName: timestampProvider
remarks: ''
isDeprecated: false
syntax:
content: 'timestampProvider?: ITimestampProvider'
return:
description: ''
type: ITimestampProvider