/
LiveShareClient.yml
105 lines (101 loc) · 3.62 KB
/
LiveShareClient.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
97
98
99
100
101
102
103
104
105
### YamlMime:TSType
name: LiveShareClient
uid: '@microsoft/live-share.LiveShareClient'
package: '@microsoft/live-share'
summary: Client used to connect to fluid containers within a Microsoft Teams context.
fullName: LiveShareClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: LiveShareClient(ILiveShareHost, ILiveShareClientOptions)
uid: '@microsoft/live-share.LiveShareClient.constructor'
package: '@microsoft/live-share'
summary: Creates a new `LiveShareClient` instance.
remarks: ''
isDeprecated: false
syntax:
content: >-
new LiveShareClient(host: ILiveShareHost, options?:
ILiveShareClientOptions)
parameters:
- id: host
type: <xref uid="@microsoft/live-share.ILiveShareHost" />
description: Host for the current Live Share session.
- id: options
type: <xref uid="@microsoft/live-share.ILiveShareClientOptions" />
description: Optional. Configuration options for the client.
properties:
- name: canSendBackgroundUpdates
uid: '@microsoft/live-share.LiveShareClient.canSendBackgroundUpdates'
package: '@microsoft/live-share'
summary: >-
Setting for whether `LiveDataObject` instances using
`LiveObjectSynchronizer` can send background updates.
Default value is `true`.
fullName: canSendBackgroundUpdates
remarks: ''
isDeprecated: false
syntax:
content: boolean canSendBackgroundUpdates
return:
description: ''
type: boolean
- name: isTesting
uid: '@microsoft/live-share.LiveShareClient.isTesting'
package: '@microsoft/live-share'
summary: If true the client is configured to use a local test server.
fullName: isTesting
remarks: ''
isDeprecated: false
syntax:
content: boolean isTesting
return:
description: ''
type: boolean
- name: maxContainerLookupTries
uid: '@microsoft/live-share.LiveShareClient.maxContainerLookupTries'
package: '@microsoft/live-share'
summary: >-
Number of times the client should attempt to get the ID of the container
to join for the
current context.
fullName: maxContainerLookupTries
remarks: ''
isDeprecated: false
syntax:
content: 'maxContainerLookupTries: number'
return:
description: ''
type: number
methods:
- name: 'joinContainer(ContainerSchema, (container: IFluidContainer) => void)'
uid: '@microsoft/live-share.LiveShareClient.joinContainer'
package: '@microsoft/live-share'
summary: Connects to the fluid container for the current teams context.
remarks: >-
The first client joining the container will create the container resulting
in the
`onContainerFirstCreated` callback being called. This callback can be used
to set the initial
state of of the containers object prior to the container being attached.
isDeprecated: false
syntax:
content: >-
function joinContainer(fluidContainerSchema: ContainerSchema,
onContainerFirstCreated?: (container: IFluidContainer) => void):
Promise<ILiveShareJoinResults>
parameters:
- id: fluidContainerSchema
type: ContainerSchema
description: Fluid objects to create.
- id: onContainerFirstCreated
type: '(container: IFluidContainer) => void'
description: >-
Optional. Callback that's called when the container is first
created.
return:
description: the results of join container.
type: >-
Promise<<xref uid="@microsoft/live-share.ILiveShareJoinResults"
/>>