@dxos/react-client 0.8.1 → 0.8.2-main.2f9c567

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (268) hide show
  1. package/dist/lib/browser/echo/index.mjs +115 -49
  2. package/dist/lib/browser/echo/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/lib/node/echo/index.cjs +113 -47
  5. package/dist/lib/node/echo/index.cjs.map +4 -4
  6. package/dist/lib/node/meta.json +1 -1
  7. package/dist/lib/node-esm/echo/index.mjs +115 -49
  8. package/dist/lib/node-esm/echo/index.mjs.map +4 -4
  9. package/dist/lib/node-esm/meta.json +1 -1
  10. package/dist/types/src/echo/index.d.ts +2 -1
  11. package/dist/types/src/echo/index.d.ts.map +1 -1
  12. package/dist/types/src/echo/useQuery.d.ts +3 -2
  13. package/dist/types/src/echo/useQuery.d.ts.map +1 -1
  14. package/dist/types/src/echo/useQueue.d.ts +2 -2
  15. package/dist/types/src/echo/useQueue.d.ts.map +1 -1
  16. package/dist/types/src/echo/useSyncState.d.ts +10 -0
  17. package/dist/types/src/echo/useSyncState.d.ts.map +1 -0
  18. package/package.json +28 -23
  19. package/project.json +2 -1
  20. package/src/echo/index.ts +2 -1
  21. package/src/echo/useQuery.ts +4 -4
  22. package/src/echo/useQueue.ts +3 -2
  23. package/src/echo/useSyncState.ts +78 -0
  24. package/tsconfig.json +3 -0
  25. package/typedoc/.nojekyll +1 -0
  26. package/typedoc/assets/hierarchy.js +1 -0
  27. package/typedoc/assets/highlight.css +99 -0
  28. package/typedoc/assets/icons.js +18 -0
  29. package/typedoc/assets/icons.svg +1 -0
  30. package/typedoc/assets/main.js +60 -0
  31. package/typedoc/assets/navigation.js +1 -0
  32. package/typedoc/assets/search.js +1 -0
  33. package/typedoc/assets/style.css +1640 -0
  34. package/typedoc/classes/echo.Filter.html +30 -0
  35. package/typedoc/classes/echo.Hypergraph.html +21 -0
  36. package/typedoc/classes/echo.PropertiesType.html +19 -0
  37. package/typedoc/classes/echo.Query.html +17 -0
  38. package/typedoc/classes/halo.KeyStore.html +6 -0
  39. package/typedoc/classes/index.AgentClientServiceProvider.html +10 -0
  40. package/typedoc/classes/index.AgentManagerClient.html +22 -0
  41. package/typedoc/classes/index.AlreadyJoinedError.html +15 -0
  42. package/typedoc/classes/index.ApiError.html +16 -0
  43. package/typedoc/classes/index.CancelledError.html +16 -0
  44. package/typedoc/classes/index.Client.html +51 -0
  45. package/typedoc/classes/index.ClientServicesProxy.html +12 -0
  46. package/typedoc/classes/index.Config.html +17 -0
  47. package/typedoc/classes/index.DataCorruptionError.html +16 -0
  48. package/typedoc/classes/index.DatabaseError.html +15 -0
  49. package/typedoc/classes/index.EntityNotFoundError.html +15 -0
  50. package/typedoc/classes/index.FakeAgentHostingProvider.html +7 -0
  51. package/typedoc/classes/index.IFrameManager.html +6 -0
  52. package/typedoc/classes/index.IdentityNotInitializedError.html +15 -0
  53. package/typedoc/classes/index.InvalidConfigError.html +16 -0
  54. package/typedoc/classes/index.InvalidInvitationError.html +15 -0
  55. package/typedoc/classes/index.InvalidInvitationExtensionRoleError.html +16 -0
  56. package/typedoc/classes/index.InvalidStorageVersionError.html +15 -0
  57. package/typedoc/classes/index.LocalClientServices.html +12 -0
  58. package/typedoc/classes/index.PublicKey.html +55 -0
  59. package/typedoc/classes/index.RemoteServiceConnectionError.html +15 -0
  60. package/typedoc/classes/index.RemoteServiceConnectionTimeout.html +15 -0
  61. package/typedoc/classes/index.RpcClosedError.html +15 -0
  62. package/typedoc/classes/index.RpcNotOpenError.html +15 -0
  63. package/typedoc/classes/index.SharedWorkerConnection.html +5 -0
  64. package/typedoc/classes/index.Shell.html +35 -0
  65. package/typedoc/classes/index.ShellManager.html +9 -0
  66. package/typedoc/classes/index.SystemError.html +16 -0
  67. package/typedoc/classes/index.UnknownModelError.html +15 -0
  68. package/typedoc/classes/index.WorkerClientServices.html +12 -0
  69. package/typedoc/classes/invitations.AuthenticatingInvitationObservable.html +30 -0
  70. package/typedoc/classes/invitations.CancellableInvitationObservable.html +29 -0
  71. package/typedoc/classes/invitations.InvitationEncoder.html +5 -0
  72. package/typedoc/classes/invitations.InvitationsProxy.html +12 -0
  73. package/typedoc/enums/devtools.KeyType.html +9 -0
  74. package/typedoc/enums/echo.HaloSpaceMember.Role.html +9 -0
  75. package/typedoc/enums/echo.IndexKind.Kind.html +6 -0
  76. package/typedoc/enums/echo.QueryOptions.DataLocation.html +6 -0
  77. package/typedoc/enums/echo.QueryOptions.ShowDeletedOption.html +6 -0
  78. package/typedoc/enums/echo.ResultFormat.html +10 -0
  79. package/typedoc/enums/echo.SpaceMember.PresenceState.html +5 -0
  80. package/typedoc/enums/echo.SpaceState.html +13 -0
  81. package/typedoc/enums/echo.TextKind.html +5 -0
  82. package/typedoc/enums/halo.Device.PresenceState.html +6 -0
  83. package/typedoc/enums/halo.DeviceKind.html +5 -0
  84. package/typedoc/enums/halo.DeviceType.html +9 -0
  85. package/typedoc/enums/index.ShellDisplay.html +5 -0
  86. package/typedoc/enums/index.ShellLayout.html +13 -0
  87. package/typedoc/enums/index.SystemStatus.html +5 -0
  88. package/typedoc/enums/invitations.Invitation.AuthMethod.html +6 -0
  89. package/typedoc/enums/invitations.Invitation.Kind.html +5 -0
  90. package/typedoc/enums/invitations.Invitation.State.html +13 -0
  91. package/typedoc/enums/invitations.Invitation.Type.html +6 -0
  92. package/typedoc/enums/mesh.ConnectionState.html +5 -0
  93. package/typedoc/functions/devtools.useDevtools.html +1 -0
  94. package/typedoc/functions/devtools.useStream.html +2 -0
  95. package/typedoc/functions/echo.useMembers.html +1 -0
  96. package/typedoc/functions/echo.useQuery.html +2 -0
  97. package/typedoc/functions/echo.useQueue.html +2 -0
  98. package/typedoc/functions/echo.useSchema.html +2 -0
  99. package/typedoc/functions/echo.useSpace.html +6 -0
  100. package/typedoc/functions/echo.useSpaceInvitation.html +1 -0
  101. package/typedoc/functions/echo.useSpaceInvitations.html +1 -0
  102. package/typedoc/functions/echo.useSpaceSyncState.html +2 -0
  103. package/typedoc/functions/echo.useSpaces.html +5 -0
  104. package/typedoc/functions/echo.useSubscription.html +3 -0
  105. package/typedoc/functions/echo.useSyncState.html +2 -0
  106. package/typedoc/functions/halo.useContacts.html +4 -0
  107. package/typedoc/functions/halo.useCredentials.html +1 -0
  108. package/typedoc/functions/halo.useDevices.html +1 -0
  109. package/typedoc/functions/halo.useHaloInvitation.html +1 -0
  110. package/typedoc/functions/halo.useHaloInvitations.html +1 -0
  111. package/typedoc/functions/halo.useIdentity.html +3 -0
  112. package/typedoc/functions/halo.useKeyStore.html +3 -0
  113. package/typedoc/functions/index.AgentHostingProvider.html +2 -0
  114. package/typedoc/functions/index.useAgentHostingClient.html +1 -0
  115. package/typedoc/functions/index.useClient.html +3 -0
  116. package/typedoc/functions/index.useClientStatus.html +1 -0
  117. package/typedoc/functions/index.useConfig.html +3 -0
  118. package/typedoc/functions/index.useShell.html +2 -0
  119. package/typedoc/functions/index.useShellDisplay.html +2 -0
  120. package/typedoc/functions/index.useStatus.html +1 -0
  121. package/typedoc/functions/invitations.useInvitationStatus.html +1 -0
  122. package/typedoc/functions/mesh.useNetworkStatus.html +2 -0
  123. package/typedoc/hierarchy.html +1 -0
  124. package/typedoc/index.html +23 -0
  125. package/typedoc/interfaces/devtools.DevtoolsHook.html +22 -0
  126. package/typedoc/interfaces/devtools.DevtoolsHost.html +26 -0
  127. package/typedoc/interfaces/echo.DocAccessor.html +3 -0
  128. package/typedoc/interfaces/echo.Echo.html +39 -0
  129. package/typedoc/interfaces/echo.EchoDatabase.html +22 -0
  130. package/typedoc/interfaces/echo.Expando.html +3 -0
  131. package/typedoc/interfaces/echo.HaloSpaceMember.html +18 -0
  132. package/typedoc/interfaces/echo.IDocHandle.html +6 -0
  133. package/typedoc/interfaces/echo.IndexKind.html +9 -0
  134. package/typedoc/interfaces/echo.QueryOptions.html +39 -0
  135. package/typedoc/interfaces/echo.Ref.html +24 -0
  136. package/typedoc/interfaces/echo.Space.html +39 -0
  137. package/typedoc/interfaces/echo.SpaceMember.html +7 -0
  138. package/typedoc/interfaces/echo.SpaceSyncState.PeerState.html +14 -0
  139. package/typedoc/interfaces/echo.SpaceSyncState.html +4 -0
  140. package/typedoc/interfaces/echo.SubscriptionHandle.html +5 -0
  141. package/typedoc/interfaces/echo.TypedObject.html +16 -0
  142. package/typedoc/interfaces/halo.Contact.html +10 -0
  143. package/typedoc/interfaces/halo.Credential.html +27 -0
  144. package/typedoc/interfaces/halo.Device.html +11 -0
  145. package/typedoc/interfaces/halo.Halo.html +16 -0
  146. package/typedoc/interfaces/halo.Identity.html +15 -0
  147. package/typedoc/interfaces/index.AgentHostingProviderClient.html +6 -0
  148. package/typedoc/interfaces/index.AppContextRequest.html +33 -0
  149. package/typedoc/interfaces/index.ClientServicesProvider.html +9 -0
  150. package/typedoc/interfaces/index.InvitationUrlRequest.html +9 -0
  151. package/typedoc/interfaces/index.LayoutRequest.html +29 -0
  152. package/typedoc/interfaces/index.ShellRuntime.html +15 -0
  153. package/typedoc/interfaces/invitations.Invitation.html +92 -0
  154. package/typedoc/interfaces/invitations.Invitations.html +5 -0
  155. package/typedoc/interfaces/mesh.GossipMessage.html +10 -0
  156. package/typedoc/interfaces/mesh.NetworkStatus.Signal.html +5 -0
  157. package/typedoc/interfaces/mesh.NetworkStatus.html +6 -0
  158. package/typedoc/media/LICENSE +8 -0
  159. package/typedoc/modules/devtools.html +1 -0
  160. package/typedoc/modules/echo.HaloSpaceMember.html +1 -0
  161. package/typedoc/modules/echo.IndexKind.html +1 -0
  162. package/typedoc/modules/echo.QueryOptions.html +1 -0
  163. package/typedoc/modules/echo.SpaceMember.html +1 -0
  164. package/typedoc/modules/echo.SpaceSyncState.html +1 -0
  165. package/typedoc/modules/echo.html +1 -0
  166. package/typedoc/modules/halo.Device.html +1 -0
  167. package/typedoc/modules/halo.html +1 -0
  168. package/typedoc/modules/index.html +1 -0
  169. package/typedoc/modules/invitations.Invitation.html +1 -0
  170. package/typedoc/modules/invitations.html +1 -0
  171. package/typedoc/modules/mesh.NetworkStatus.html +1 -0
  172. package/typedoc/modules/mesh.html +1 -0
  173. package/typedoc/modules/worker.html +1 -0
  174. package/typedoc/modules.html +1 -0
  175. package/typedoc/types/devtools.MountOptions.html +3 -0
  176. package/typedoc/types/echo.AnyLiveObject.html +1 -0
  177. package/typedoc/types/echo.FilterSource.html +1 -0
  178. package/typedoc/types/echo.Live.html +5 -0
  179. package/typedoc/types/echo.ObjectMeta.html +1 -0
  180. package/typedoc/types/echo.ObjectMigration.html +7 -0
  181. package/typedoc/types/echo.ObjectVersion.html +2 -0
  182. package/typedoc/types/echo.PeerSyncState.html +1 -0
  183. package/typedoc/types/echo.Progress.html +3 -0
  184. package/typedoc/types/echo.PropertiesTypeProps.html +1 -0
  185. package/typedoc/types/echo.Queue.html +10 -0
  186. package/typedoc/types/echo.Selection.html +1 -0
  187. package/typedoc/types/echo.SpaceId.html +6 -0
  188. package/typedoc/types/echo.SpaceSyncStateMap.html +1 -0
  189. package/typedoc/types/echo.UseQueueOptions.html +2 -0
  190. package/typedoc/types/echo.UseSpacesParams.html +3 -0
  191. package/typedoc/types/index.AgentHostingProviderProps.html +3 -0
  192. package/typedoc/types/index.ClientContextProps.html +3 -0
  193. package/typedoc/types/index.ClientOptions.html +12 -0
  194. package/typedoc/types/index.ClientProviderProps.html +2 -0
  195. package/typedoc/types/index.ClientServices.html +15 -0
  196. package/typedoc/types/index.FromAgentOptions.html +2 -0
  197. package/typedoc/types/index.PublicKeyLike.html +2 -0
  198. package/typedoc/types/invitations.InvitationAction.html +1 -0
  199. package/typedoc/types/invitations.InvitationResult.html +5 -0
  200. package/typedoc/types/invitations.InvitationStatus.html +15 -0
  201. package/typedoc/variables/devtools.mountDevtoolsHooks.html +1 -0
  202. package/typedoc/variables/devtools.unmountDevtoolsHooks.html +1 -0
  203. package/typedoc/variables/echo.DocAccessor.html +1 -0
  204. package/typedoc/variables/echo.EchoObjectSchema.html +1 -0
  205. package/typedoc/variables/echo.Expando.html +1 -0
  206. package/typedoc/variables/echo.FQ_ID_LENGTH.html +1 -0
  207. package/typedoc/variables/echo.OBJECT_ID_LENGTH.html +1 -0
  208. package/typedoc/variables/echo.ObjectVersion.html +1 -0
  209. package/typedoc/variables/echo.ReactiveObjectSchema.html +1 -0
  210. package/typedoc/variables/echo.Ref.html +2 -0
  211. package/typedoc/variables/echo.RefArray.html +2 -0
  212. package/typedoc/variables/echo.SPACE_ID_LENGTH.html +1 -0
  213. package/typedoc/variables/echo.SpaceId.html +1 -0
  214. package/typedoc/variables/echo.SpaceSchema.html +1 -0
  215. package/typedoc/variables/echo.TypedObject.html +3 -0
  216. package/typedoc/variables/echo.compareForeignKeys.html +1 -0
  217. package/typedoc/variables/echo.createDocAccessor.html +1 -0
  218. package/typedoc/variables/echo.createEmptyEdgeSyncState.html +1 -0
  219. package/typedoc/variables/echo.createObject.html +1 -0
  220. package/typedoc/variables/echo.createQueueDxn.html +1 -0
  221. package/typedoc/variables/echo.createSubscription.html +5 -0
  222. package/typedoc/variables/echo.defineObjectMigration.html +1 -0
  223. package/typedoc/variables/echo.fromCursor.html +1 -0
  224. package/typedoc/variables/echo.fullyQualifiedId.html +4 -0
  225. package/typedoc/variables/echo.getMeta.html +1 -0
  226. package/typedoc/variables/echo.getObjectCore.html +1 -0
  227. package/typedoc/variables/echo.getRangeFromCursor.html +1 -0
  228. package/typedoc/variables/echo.getSchema.html +2 -0
  229. package/typedoc/variables/echo.getSpace.html +1 -0
  230. package/typedoc/variables/echo.getSyncSummary.html +1 -0
  231. package/typedoc/variables/echo.getTextInRange.html +2 -0
  232. package/typedoc/variables/echo.getType.html +5 -0
  233. package/typedoc/variables/echo.getTypename.html +2 -0
  234. package/typedoc/variables/echo.getVersion.html +3 -0
  235. package/typedoc/variables/echo.hasType.html +2 -0
  236. package/typedoc/variables/echo.importSpace.html +1 -0
  237. package/typedoc/variables/echo.internalDecodeReference.html +1 -0
  238. package/typedoc/variables/echo.isEchoObject.html +2 -0
  239. package/typedoc/variables/echo.isLiveObject.html +2 -0
  240. package/typedoc/variables/echo.isSpace.html +1 -0
  241. package/typedoc/variables/echo.live.html +3 -0
  242. package/typedoc/variables/echo.loadObjectReferences.html +7 -0
  243. package/typedoc/variables/echo.makeRef.html +2 -0
  244. package/typedoc/variables/echo.parseFullyQualifiedId.html +2 -0
  245. package/typedoc/variables/echo.parseId.html +1 -0
  246. package/typedoc/variables/echo.refFromDXN.html +2 -0
  247. package/typedoc/variables/echo.toCursor.html +1 -0
  248. package/typedoc/variables/echo.toCursorRange.html +1 -0
  249. package/typedoc/variables/echo.updateText.html +6 -0
  250. package/typedoc/variables/index.AgentHostingContext.html +1 -0
  251. package/typedoc/variables/index.ClientProvider.html +3 -0
  252. package/typedoc/variables/index.DXOS_VERSION.html +1 -0
  253. package/typedoc/variables/index.Defaults.html +2 -0
  254. package/typedoc/variables/index.Dynamics.html +2 -0
  255. package/typedoc/variables/index.Envs.html +2 -0
  256. package/typedoc/variables/index.Local.html +2 -0
  257. package/typedoc/variables/index.Remote.html +1 -0
  258. package/typedoc/variables/index.Storage.html +2 -0
  259. package/typedoc/variables/index.createClientServices.html +4 -0
  260. package/typedoc/variables/index.fromAgent.html +2 -0
  261. package/typedoc/variables/index.fromHost.html +2 -0
  262. package/typedoc/variables/index.fromSocket.html +2 -0
  263. package/typedoc/variables/index.fromWorker.html +2 -0
  264. package/typedoc/variables/index.getUnixSocket.html +1 -0
  265. package/typedoc/variables/index.resolveRef.html +1 -0
  266. package/typedoc/variables/index.useMulticastObservable.html +3 -0
  267. package/typedoc/variables/worker.getWorkerServiceHost.html +1 -0
  268. package/typedoc/variables/worker.onconnect.html +1 -0
package/typedoc/interfaces/echo.Space.html ADDED
@@ -0,0 +1,39 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Space | @dxos/react-client</title><meta name="description" content="Documentation for @dxos/react-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@dxos/react-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/echo.html">echo</a></li><li><a href="" aria-current="page">Space</a></li></ul><h1>Interface Space</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Space</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#listen">listen</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="mesh.GossipMessage.html" class="tsd-signature-type tsd-kind-interface">GossipMessage</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">CleanupFn</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#postmessage">postMessage</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#crudcrud">crud</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CoreDatabase</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#dbdb">db</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="echo.EchoDatabase.html" class="tsd-signature-type tsd-kind-interface">EchoDatabase</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#idid">id</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/echo.SpaceId.html" class="tsd-signature-type tsd-kind-type-alias">SpaceId</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#internalinternal">internal</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SpaceInternal</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#invitationsinvitations">invitations</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#isopenisopen">isOpen</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#keykey">key</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../classes/index.PublicKey.html" class="tsd-signature-type tsd-kind-class">PublicKey</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#membersmembers">members</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="echo.SpaceMember.html" class="tsd-signature-type tsd-kind-interface">SpaceMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#pipelinepipeline">pipeline</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PipelineState</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#propertiesproperties">properties</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#queuesqueues">queues</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">QueueFactory</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-keyword">get</span> <a class="tsd-kind-get-signature" href="#statestate">state</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/echo.SpaceState.html" class="tsd-signature-type tsd-kind-enum">SpaceState</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#admitcontact-1">admitContact</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="halo.Contact.html" class="tsd-signature-type tsd-kind-interface">Contact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#close-1">close</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#createsnapshot-1">createSnapshot</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SpaceSnapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#open-1">open</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#share-1">share</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="invitations.Invitation.html" class="tsd-signature-type tsd-kind-interface">Invitation</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#updatememberrole-1">updateMemberRole</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">UpdateMemberRoleRequest</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;spaceKey&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#waituntilready-1">waitUntilReady</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-interface">Space</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:28</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#listen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listen</span></a>
2
+ <a href="#postmessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Message</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#crud" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>crud</span></a>
4
+ <a href="#db" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>db</span></a>
5
+ <a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a>
6
+ <a href="#internal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>internal</span></a>
7
+ <a href="#invitations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invitations</span></a>
8
+ <a href="#isopen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Open</span></a>
9
+ <a href="#key" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>key</span></a>
10
+ <a href="#members" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>members</span></a>
11
+ <a href="#pipeline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pipeline</span></a>
12
+ <a href="#properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>properties</span></a>
13
+ <a href="#queues" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>queues</span></a>
14
+ <a href="#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state</span></a>
15
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#admitcontact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>admit<wbr/>Contact</span></a>
16
+ <a href="#close" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a>
17
+ <a href="#createsnapshot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Snapshot</span></a>
18
+ <a href="#open" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open</span></a>
19
+ <a href="#share" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>share</span></a>
20
+ <a href="#updatememberrole" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Member<wbr/>Role</span></a>
21
+ <a href="#waituntilready" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>Until<wbr/>Ready</span></a>
22
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listen"><span>listen</span><a href="#listen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">listen</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="mesh.GossipMessage.html" class="tsd-signature-type tsd-kind-interface">GossipMessage</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">CleanupFn</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="postmessage"><span>post<wbr/>Message</span><a href="#postmessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">postMessage</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:90</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="crud"><span>crud</span><a href="#crud" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="crudcrud"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">crud</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CoreDatabase</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Echo database CRUD API.</p>
23
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CoreDatabase</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use the database api with the <code>plain</code> format.</p>
24
+ </div></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:49</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="db"><span>db</span><a href="#db" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="dbdb"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">db</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="echo.EchoDatabase.html" class="tsd-signature-type tsd-kind-interface">EchoDatabase</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Echo database.</p>
25
+ </div><h4 class="tsd-returns-title">Returns <a href="echo.EchoDatabase.html" class="tsd-signature-type tsd-kind-interface">EchoDatabase</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:40</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="idid"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">id</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/echo.SpaceId.html" class="tsd-signature-type tsd-kind-type-alias">SpaceId</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unique space identifier.</p>
26
+ </div><h4 class="tsd-returns-title">Returns <a href="../types/echo.SpaceId.html" class="tsd-signature-type tsd-kind-type-alias">SpaceId</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:32</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="internal"><span>internal</span><a href="#internal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="internalinternal"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">internal</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SpaceInternal</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SpaceInternal</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:70</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitations"><span>invitations</span><a href="#invitations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="invitationsinvitations"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">invitations</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:65</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isopen"><span>is<wbr/>Open</span><a href="#isopen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="isopenisopen"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isOpen</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:50</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="key"><span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="keykey"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">key</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../classes/index.PublicKey.html" class="tsd-signature-type tsd-kind-class">PublicKey</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../classes/index.PublicKey.html" class="tsd-signature-type tsd-kind-class">PublicKey</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <code>id</code>.</p>
27
+ </div></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:36</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="members"><span>members</span><a href="#members" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="membersmembers"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">members</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="echo.SpaceMember.html" class="tsd-signature-type tsd-kind-interface">SpaceMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="echo.SpaceMember.html" class="tsd-signature-type tsd-kind-interface">SpaceMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:66</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pipeline"><span>pipeline</span><a href="#pipeline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pipelinepipeline"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pipeline</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PipelineState</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Current state of space pipeline.</p>
28
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PipelineState</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:64</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="properties"><span>properties</span><a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="propertiesproperties"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">properties</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Properties object.</p>
29
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:54</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="queues"><span>queues</span><a href="#queues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="queuesqueues"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">queues</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">QueueFactory</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Access to queues.</p>
30
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">QueueFactory</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:44</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="statestate"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">state</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/echo.SpaceState.html" class="tsd-signature-type tsd-kind-enum">SpaceState</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Current state of the space.
31
+ The database is ready to be used in <code>SpaceState.SPACE_READY</code> state.
32
+ Presence is available in <code>SpaceState.SPACE_CONTROL_ONLY</code> state.</p>
33
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MulticastObservable</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/echo.SpaceState.html" class="tsd-signature-type tsd-kind-enum">SpaceState</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:60</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="admitcontact"><span>admit<wbr/>Contact</span><a href="#admitcontact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="admitcontact-1"><span class="tsd-kind-call-signature">admitContact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="halo.Contact.html" class="tsd-signature-type tsd-kind-interface">Contact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#admitcontact-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="halo.Contact.html" class="tsd-signature-type tsd-kind-interface">Contact</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:88</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="close"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="close-1"><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deactivates the space stopping replication with other peers.
34
+ The space will not auto-open on the next app launch.
35
+ The setting is persisted on the local device.</p>
36
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:81</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createsnapshot"><span>create<wbr/>Snapshot</span><a href="#createsnapshot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="createsnapshot-1"><span class="tsd-kind-call-signature">createSnapshot</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SpaceSnapshot</span><span class="tsd-signature-symbol">&gt;</span><a href="#createsnapshot-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SpaceSnapshot</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:86</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="open"><span>open</span><a href="#open" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="open-1"><span class="tsd-kind-call-signature">open</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#open-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Activates the space enabling the use of the database and starts replication with peers.
37
+ The setting is persisted on the local device.</p>
38
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:75</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="share"><span>share</span><a href="#share" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="share-1"><span class="tsd-kind-call-signature">share</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="invitations.Invitation.html" class="tsd-signature-type tsd-kind-interface">Invitation</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a><a href="#share-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="invitations.Invitation.html" class="tsd-signature-type tsd-kind-interface">Invitation</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/invitations.CancellableInvitationObservable.html" class="tsd-signature-type tsd-kind-class">CancellableInvitationObservable</a></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:87</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatememberrole"><span>update<wbr/>Member<wbr/>Role</span><a href="#updatememberrole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatememberrole-1"><span class="tsd-kind-call-signature">updateMemberRole</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">UpdateMemberRoleRequest</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;spaceKey&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#updatememberrole-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">UpdateMemberRoleRequest</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;spaceKey&quot;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:89</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="waituntilready"><span>wait<wbr/>Until<wbr/>Ready</span><a href="#waituntilready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="waituntilready-1"><span class="tsd-kind-call-signature">waitUntilReady</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-interface">Space</a><span class="tsd-signature-symbol">&gt;</span><a href="#waituntilready-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits until the space is in the ready state, with database initialized.</p>
39
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-interface">Space</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/space.d.ts:85</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#listen"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listen</span></a><a href="#postmessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Message</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#crud"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>crud</span></a><a href="#db"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>db</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a><a href="#internal"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>internal</span></a><a href="#invitations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invitations</span></a><a href="#isopen"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Open</span></a><a href="#key"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>key</span></a><a href="#members"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>members</span></a><a href="#pipeline"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pipeline</span></a><a href="#properties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>properties</span></a><a href="#queues"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>queues</span></a><a href="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#admitcontact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>admit<wbr/>Contact</span></a><a href="#close"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a><a href="#createsnapshot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Snapshot</span></a><a href="#open"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open</span></a><a href="#share"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>share</span></a><a href="#updatememberrole"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Member<wbr/>Role</span></a><a href="#waituntilready"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>Until<wbr/>Ready</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@dxos/react-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/typedoc/interfaces/echo.SpaceMember.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpaceMember | @dxos/react-client</title><meta name="description" content="Documentation for @dxos/react-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@dxos/react-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/echo.html">echo</a></li><li><a href="" aria-current="page">SpaceMember</a></li></ul><h1>Interface SpaceMember</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../../dxos/client/services.proto</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SpaceMember</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#identity">identity</a><span class="tsd-signature-symbol">:</span> <a href="halo.Identity.html" class="tsd-signature-type tsd-kind-interface">Identity</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#peerstates">peerStates</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerState</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#presence">presence</a><span class="tsd-signature-symbol">:</span> <a href="../modules/echo.SpaceMember.html" class="tsd-signature-type tsd-kind-namespace">SpaceMember</a><span class="tsd-signature-symbol">.</span><a href="../enums/echo.SpaceMember.PresenceState.html" class="tsd-signature-type tsd-kind-enum">PresenceState</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">:</span> <a href="../enums/echo.HaloSpaceMember.Role.html" class="tsd-signature-type tsd-kind-enum">Role</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:770</li><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:776</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#identity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>identity</span></a>
4
+ <a href="#peerstates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>States?</span></a>
5
+ <a href="#presence" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>presence</span></a>
6
+ <a href="#role" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="identity"><span>identity</span><a href="#identity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">identity</span><span class="tsd-signature-symbol">:</span> <a href="halo.Identity.html" class="tsd-signature-type tsd-kind-interface">Identity</a></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:771</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="peerstates"><code class="tsd-tag">Optional</code><span>peer<wbr/>States</span><a href="#peerstates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">peerStates</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerState</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:773</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="presence"><span>presence</span><a href="#presence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">presence</span><span class="tsd-signature-symbol">:</span> <a href="../modules/echo.SpaceMember.html" class="tsd-signature-type tsd-kind-namespace">SpaceMember</a><span class="tsd-signature-symbol">.</span><a href="../enums/echo.SpaceMember.PresenceState.html" class="tsd-signature-type tsd-kind-enum">PresenceState</a></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:772</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="role"><span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">:</span> <a href="../enums/echo.HaloSpaceMember.Role.html" class="tsd-signature-type tsd-kind-enum">Role</a></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts:774</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#identity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>identity</span></a><a href="#peerstates"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>States</span></a><a href="#presence"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>presence</span></a><a href="#role"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@dxos/react-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/typedoc/interfaces/echo.SpaceSyncState.PeerState.html ADDED
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PeerState | @dxos/react-client</title><meta name="description" content="Documentation for @dxos/react-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@dxos/react-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/echo.html">echo</a></li><li><a href="../modules/echo.SpaceSyncState.html">SpaceSyncState</a></li><li><a href="" aria-current="page">PeerState</a></li></ul><h1>Interface PeerState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../../dxos/echo/service.proto</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PeerState</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#differentdocuments">differentDocuments</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#localdocumentcount">localDocumentCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#missingonlocal">missingOnLocal</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#missingonremote">missingOnRemote</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#peerid">peerId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#remotedocumentcount">remoteDocumentCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:143</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#differentdocuments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>different<wbr/>Documents</span></a>
4
+ <a href="#localdocumentcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Document<wbr/>Count</span></a>
5
+ <a href="#missingonlocal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>On<wbr/>Local</span></a>
6
+ <a href="#missingonremote" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>On<wbr/>Remote</span></a>
7
+ <a href="#peerid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Id</span></a>
8
+ <a href="#remotedocumentcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remote<wbr/>Document<wbr/>Count</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="differentdocuments"><span>different<wbr/>Documents</span><a href="#differentdocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">differentDocuments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Documents that are present on both peers but have different heads.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:156</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="localdocumentcount"><span>local<wbr/>Document<wbr/>Count</span><a href="#localdocumentcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">localDocumentCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Total number of documents locally.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:160</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="missingonlocal"><span>missing<wbr/>On<wbr/>Local</span><a href="#missingonlocal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">missingOnLocal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Documents that are present on the remote peer but not locally.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:152</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="missingonremote"><span>missing<wbr/>On<wbr/>Remote</span><a href="#missingonremote" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">missingOnRemote</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Documents that are present locally but not on the remote peer.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="peerid"><span>peer<wbr/>Id</span><a href="#peerid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">peerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:144</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="remotedocumentcount"><span>remote<wbr/>Document<wbr/>Count</span><a href="#remotedocumentcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">remoteDocumentCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Total number of documents on the remote peer.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:164</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#differentdocuments"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>different<wbr/>Documents</span></a><a href="#localdocumentcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Document<wbr/>Count</span></a><a href="#missingonlocal"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>On<wbr/>Local</span></a><a href="#missingonremote"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>missing<wbr/>On<wbr/>Remote</span></a><a href="#peerid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Id</span></a><a href="#remotedocumentcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remote<wbr/>Document<wbr/>Count</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@dxos/react-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/typedoc/interfaces/echo.SpaceSyncState.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpaceSyncState | @dxos/react-client</title><meta name="description" content="Documentation for @dxos/react-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@dxos/react-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/echo.html">echo</a></li><li><a href="" aria-current="page">SpaceSyncState</a></li></ul><h1>Interface SpaceSyncState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../../dxos/echo/service.proto</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SpaceSyncState</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#peers">peers</a><span class="tsd-signature-symbol">?:</span> <a href="echo.SpaceSyncState.PeerState.html" class="tsd-signature-type tsd-kind-interface">PeerState</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:135</li><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:138</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#peers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peers?</span></a>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="peers"><code class="tsd-tag">Optional</code><span>peers</span><a href="#peers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">peers</span><span class="tsd-signature-symbol">?:</span> <a href="echo.SpaceSyncState.PeerState.html" class="tsd-signature-type tsd-kind-interface">PeerState</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/esm/src/proto/gen/dxos/echo/service.d.ts:136</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#peers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peers</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@dxos/react-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/typedoc/interfaces/echo.SubscriptionHandle.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SubscriptionHandle | @dxos/react-client</title><meta name="description" content="Documentation for @dxos/react-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@dxos/react-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/echo.html">echo</a></li><li><a href="" aria-current="page">SubscriptionHandle</a></li></ul><h1>Interface SubscriptionHandle</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SubscriptionHandle</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#selected">selected</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#subscribed">subscribed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#unsubscribe">unsubscribe</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#update">update</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">selection</span><span class="tsd-signature-symbol">:</span> <a href="../types/echo.Selection.html" class="tsd-signature-type tsd-kind-type-alias">Selection</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="" class="tsd-signature-type tsd-kind-interface">SubscriptionHandle</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/echo/echo-db/dist/types/src/query/subscription.d.ts:2</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#selected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected</span></a>
2
+ <a href="#subscribed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribed</span></a>
3
+ <a href="#unsubscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a>
4
+ <a href="#update" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selected"><span>selected</span><a href="#selected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/echo/echo-db/dist/types/src/query/subscription.d.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="subscribed"><span>subscribed</span><a href="#subscribed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subscribed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/echo/echo-db/dist/types/src/query/subscription.d.ts:4</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unsubscribe"><span>unsubscribe</span><a href="#unsubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsubscribe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/echo/echo-db/dist/types/src/query/subscription.d.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">update</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">selection</span><span class="tsd-signature-symbol">:</span> <a href="../types/echo.Selection.html" class="tsd-signature-type tsd-kind-type-alias">Selection</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="" class="tsd-signature-type tsd-kind-interface">SubscriptionHandle</a></div><aside class="tsd-sources"><ul><li>Defined in packages/core/echo/echo-db/dist/types/src/query/subscription.d.ts:3</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#selected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected</span></a><a href="#subscribed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subscribed</span></a><a href="#unsubscribe"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@dxos/react-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>