@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/index.AppContextRequest.html ADDED
@@ -0,0 +1,33 @@
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>AppContextRequest | @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/index.html">index</a></li><li><a href="" aria-current="page">AppContextRequest</a></li></ul><h1>Interface AppContextRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../dxos/iframe.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">AppContextRequest</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#display">display</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/index.ShellDisplay.html" class="tsd-signature-type tsd-kind-enum">ShellDisplay</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#reset">reset</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="#spaceid">spaceId</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="#spacekey">spaceKey</a><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/>    <a class="tsd-kind-property" href="#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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/iframe.d.ts:49</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="#display" 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>display?</span></a>
4
+ <a href="#reset" 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>reset?</span></a>
5
+ <a href="#spaceid" 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>space<wbr/>Id?</span></a>
6
+ <a href="#spacekey" 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>space<wbr/>Key?</span></a>
7
+ <a href="#target" 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>target?</span></a>
8
+ </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="display"><code class="tsd-tag">Optional</code><span>display</span><a href="#display" 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">display</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/index.ShellDisplay.html" class="tsd-signature-type tsd-kind-enum">ShellDisplay</a></div><div class="tsd-comment tsd-typography"><p>The display mode that shell should use.</p>
9
+ <p>Options:</p>
10
+ <ul>
11
+ <li>proto3_optional = true</li>
12
+ </ul>
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/iframe.d.ts:56</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reset"><code class="tsd-tag">Optional</code><span>reset</span><a href="#reset" 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">reset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Shell cannot reload the app from within an iframe.</p>
14
+ <p>Options:</p>
15
+ <ul>
16
+ <li>proto3_optional = true</li>
17
+ </ul>
18
+ </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/iframe.d.ts:84</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spaceid"><code class="tsd-tag">Optional</code><span>space<wbr/>Id</span><a href="#spaceid" 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">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The id of the joined space.</p>
19
+ <p>Options:</p>
20
+ <ul>
21
+ <li>proto3_optional = true</li>
22
+ </ul>
23
+ </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/iframe.d.ts:70</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spacekey"><code class="tsd-tag">Optional</code><span>space<wbr/>Key</span><a href="#spacekey" 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">spaceKey</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-comment tsd-typography"><p>The key of the joined space.</p>
24
+ <p>Options:</p>
25
+ <ul>
26
+ <li>proto3_optional = true</li>
27
+ </ul>
28
+ </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/iframe.d.ts:63</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="target"><code class="tsd-tag">Optional</code><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Target to redirect to after a successful invitation.</p>
29
+ <p>Options:</p>
30
+ <ul>
31
+ <li>proto3_optional = true</li>
32
+ </ul>
33
+ </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/iframe.d.ts:77</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="#display"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display</span></a><a href="#reset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reset</span></a><a href="#spaceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Id</span></a><a href="#spacekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Key</span></a><a href="#target"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</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/index.ClientServicesProvider.html ADDED
@@ -0,0 +1,9 @@
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>ClientServicesProvider | @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/index.html">index</a></li><li><a href="" aria-current="page">ClientServicesProvider</a></li></ul><h1>Interface ClientServicesProvider</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Provide access to client services definitions and service handler.</p>
2
+ </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">ClientServicesProvider</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#closed">closed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#descriptors">descriptors</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServiceBundle</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.ClientServices.html" class="tsd-signature-type tsd-kind-type-alias">ClientServices</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#services">services</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.ClientServices.html" class="tsd-signature-type tsd-kind-type-alias">ClientServices</a><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="#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/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/index.AgentClientServiceProvider.html" class="tsd-signature-type tsd-kind-class">AgentClientServiceProvider</a></li><li><a href="../classes/index.ClientServicesProxy.html" class="tsd-signature-type tsd-kind-class">ClientServicesProxy</a></li><li><a href="../classes/index.LocalClientServices.html" class="tsd-signature-type tsd-kind-class">LocalClientServices</a></li><li><a href="../classes/index.WorkerClientServices.html" class="tsd-signature-type tsd-kind-class">WorkerClientServices</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/service-definitions.d.ts:30</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="#closed" 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>closed</span></a>
3
+ <a href="#descriptors" 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>descriptors</span></a>
4
+ <a href="#services" 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>services</span></a>
5
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><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>
6
+ <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>
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="closed"><span>closed</span><a href="#closed" 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">closed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>The connection to the services provider was terminated.
8
+ This should fire if the services disconnect unexpectedly or during a client reset.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/service-definitions.d.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="descriptors"><span>descriptors</span><a href="#descriptors" 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">descriptors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ServiceBundle</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.ClientServices.html" class="tsd-signature-type tsd-kind-type-alias">ClientServices</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/service-definitions.d.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="services"><span>services</span><a href="#services" 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">services</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/index.ClientServices.html" class="tsd-signature-type tsd-kind-type-alias">ClientServices</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/service-definitions.d.ts:37</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-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="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"><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/service-definitions.d.ts:39</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"><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/service-definitions.d.ts:38</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="#closed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>closed</span></a><a href="#descriptors"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>descriptors</span></a><a href="#services"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>services</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="#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="#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></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/index.InvitationUrlRequest.html ADDED
@@ -0,0 +1,9 @@
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>InvitationUrlRequest | @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/index.html">index</a></li><li><a href="" aria-current="page">InvitationUrlRequest</a></li></ul><h1>Interface InvitationUrlRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../dxos/iframe.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">InvitationUrlRequest</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#deviceinvitationparam">deviceInvitationParam</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="#invitationurl">invitationUrl</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="#spaceinvitationparam">spaceInvitationParam</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/iframe.d.ts:153</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="#deviceinvitationparam" 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>device<wbr/>Invitation<wbr/>Param</span></a>
4
+ <a href="#invitationurl" 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>invitation<wbr/>Url</span></a>
5
+ <a href="#spaceinvitationparam" 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>space<wbr/>Invitation<wbr/>Param</span></a>
6
+ </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="deviceinvitationparam"><span>device<wbr/>Invitation<wbr/>Param</span><a href="#deviceinvitationparam" 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">deviceInvitationParam</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Query parameter for device invitations.</p>
7
+ </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/iframe.d.ts:161</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitationurl"><span>invitation<wbr/>Url</span><a href="#invitationurl" 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">invitationUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Base URL for invitations.</p>
8
+ </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/iframe.d.ts:157</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spaceinvitationparam"><span>space<wbr/>Invitation<wbr/>Param</span><a href="#spaceinvitationparam" 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">spaceInvitationParam</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Query parameter for space invitations.</p>
9
+ </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/iframe.d.ts:165</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="#deviceinvitationparam"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>device<wbr/>Invitation<wbr/>Param</span></a><a href="#invitationurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invitation<wbr/>Url</span></a><a href="#spaceinvitationparam"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Invitation<wbr/>Param</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/index.LayoutRequest.html ADDED
@@ -0,0 +1,29 @@
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>LayoutRequest | @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/index.html">index</a></li><li><a href="" aria-current="page">LayoutRequest</a></li></ul><h1>Interface LayoutRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defined in:
2
+ file://./../../dxos/iframe.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">LayoutRequest</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#invitationcode">invitationCode</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="#layout">layout</a><span class="tsd-signature-symbol">:</span> <a href="../enums/index.ShellLayout.html" class="tsd-signature-type tsd-kind-enum">ShellLayout</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#spaceid">spaceId</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="#spacekey">spaceKey</a><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/>    <a class="tsd-kind-property" href="#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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/iframe.d.ts:115</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="#invitationcode" 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>invitation<wbr/>Code?</span></a>
4
+ <a href="#layout" 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>layout</span></a>
5
+ <a href="#spaceid" 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>space<wbr/>Id?</span></a>
6
+ <a href="#spacekey" 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>space<wbr/>Key?</span></a>
7
+ <a href="#target" 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>target?</span></a>
8
+ </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="invitationcode"><code class="tsd-tag">Optional</code><span>invitation<wbr/>Code</span><a href="#invitationcode" 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">invitationCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Invitation code to join a space/identity.</p>
9
+ <p>Options:</p>
10
+ <ul>
11
+ <li>proto3_optional = true</li>
12
+ </ul>
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/iframe.d.ts:126</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="layout"><span>layout</span><a href="#layout" 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">layout</span><span class="tsd-signature-symbol">:</span> <a href="../enums/index.ShellLayout.html" class="tsd-signature-type tsd-kind-enum">ShellLayout</a></div><div class="tsd-comment tsd-typography"><p>Determins which panel of the shell is opened.</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/iframe.d.ts:119</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spaceid"><code class="tsd-tag">Optional</code><span>space<wbr/>Id</span><a href="#spaceid" 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">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Id of the space to share.</p>
15
+ <p>Options:</p>
16
+ <ul>
17
+ <li>proto3_optional = true</li>
18
+ </ul>
19
+ </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/iframe.d.ts:140</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spacekey"><code class="tsd-tag">Optional</code><span>space<wbr/>Key</span><a href="#spacekey" 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">spaceKey</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-comment tsd-typography"><p>Key of the space to share.</p>
20
+ <p>Options:</p>
21
+ <ul>
22
+ <li>proto3_optional = true</li>
23
+ </ul>
24
+ </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/iframe.d.ts:133</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="target"><code class="tsd-tag">Optional</code><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Target to include in an invitation for redirecting after a successful invitation.</p>
25
+ <p>Options:</p>
26
+ <ul>
27
+ <li>proto3_optional = true</li>
28
+ </ul>
29
+ </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/iframe.d.ts:147</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="#invitationcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invitation<wbr/>Code</span></a><a href="#layout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layout</span></a><a href="#spaceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Id</span></a><a href="#spacekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Key</span></a><a href="#target"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</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/index.ShellRuntime.html ADDED
@@ -0,0 +1,15 @@
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>ShellRuntime | @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/index.html">index</a></li><li><a href="" aria-current="page">ShellRuntime</a></li></ul><h1>Interface ShellRuntime</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ShellRuntime</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#deviceinvitationparam">deviceInvitationParam</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="#invitationcode">invitationCode</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="#invitationurl">invitationUrl</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="#invitationurlupdate">invitationUrlUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InvitationUrlRequest.html" class="tsd-signature-type tsd-kind-interface">InvitationUrlRequest</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#layout">layout</a><span class="tsd-signature-symbol">:</span> <a href="../enums/index.ShellLayout.html" class="tsd-signature-type tsd-kind-enum">ShellLayout</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#layoutupdate">layoutUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><a href="index.LayoutRequest.html" class="tsd-signature-type tsd-kind-interface">LayoutRequest</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#setappcontext">setAppContext</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="index.AppContextRequest.html" class="tsd-signature-type tsd-kind-interface">AppContextRequest</a><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/>    <a class="tsd-kind-property" href="#setinvitationurl">setInvitationUrl</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="index.InvitationUrlRequest.html" class="tsd-signature-type tsd-kind-interface">InvitationUrlRequest</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/>    <a class="tsd-kind-property" href="#setlayout">setLayout</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="index.LayoutRequest.html" class="tsd-signature-type tsd-kind-interface">LayoutRequest</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/>    <a class="tsd-kind-property" href="#spaceid">spaceId</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="#spaceinvitationparam">spaceInvitationParam</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="#spacekey">spaceKey</a><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/>    <a class="tsd-kind-property" href="#target">target</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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/shell.d.ts:4</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="#deviceinvitationparam" 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>device<wbr/>Invitation<wbr/>Param</span></a>
2
+ <a href="#invitationcode" 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>invitation<wbr/>Code?</span></a>
3
+ <a href="#invitationurl" 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>invitation<wbr/>Url</span></a>
4
+ <a href="#invitationurlupdate" 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>invitation<wbr/>Url<wbr/>Update</span></a>
5
+ <a href="#layout" 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>layout</span></a>
6
+ <a href="#layoutupdate" 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>layout<wbr/>Update</span></a>
7
+ <a href="#setappcontext" 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>set<wbr/>App<wbr/>Context</span></a>
8
+ <a href="#setinvitationurl" 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>set<wbr/>Invitation<wbr/>Url</span></a>
9
+ <a href="#setlayout" 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>set<wbr/>Layout</span></a>
10
+ <a href="#spaceid" 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>space<wbr/>Id?</span></a>
11
+ <a href="#spaceinvitationparam" 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>space<wbr/>Invitation<wbr/>Param</span></a>
12
+ <a href="#spacekey" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Key?</span></a>
13
+ <a href="#target" 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>target?</span></a>
14
+ </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="deviceinvitationparam"><span>device<wbr/>Invitation<wbr/>Param</span><a href="#deviceinvitationparam" 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">deviceInvitationParam</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitationcode"><code class="tsd-tag">Optional</code><span>invitation<wbr/>Code</span><a href="#invitationcode" 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">invitationCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:12</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitationurl"><span>invitation<wbr/>Url</span><a href="#invitationurl" 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">invitationUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitationurlupdate"><span>invitation<wbr/>Url<wbr/>Update</span><a href="#invitationurlupdate" 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">invitationUrlUpdate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InvitationUrlRequest.html" class="tsd-signature-type tsd-kind-interface">InvitationUrlRequest</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="layout"><span>layout</span><a href="#layout" 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">layout</span><span class="tsd-signature-symbol">:</span> <a href="../enums/index.ShellLayout.html" class="tsd-signature-type tsd-kind-enum">ShellLayout</a></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:7</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="layoutupdate"><span>layout<wbr/>Update</span><a href="#layoutupdate" 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">layoutUpdate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">&lt;</span><a href="index.LayoutRequest.html" class="tsd-signature-type tsd-kind-interface">LayoutRequest</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setappcontext"><span>set<wbr/>App<wbr/>Context</span><a href="#setappcontext" 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">setAppContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="index.AppContextRequest.html" class="tsd-signature-type tsd-kind-interface">AppContextRequest</a><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/shell.d.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setinvitationurl"><span>set<wbr/>Invitation<wbr/>Url</span><a href="#setinvitationurl" 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">setInvitationUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="index.InvitationUrlRequest.html" class="tsd-signature-type tsd-kind-interface">InvitationUrlRequest</a><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/sdk/client-protocol/dist/types/src/shell.d.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setlayout"><span>set<wbr/>Layout</span><a href="#setlayout" 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">setLayout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="index.LayoutRequest.html" class="tsd-signature-type tsd-kind-interface">LayoutRequest</a><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/sdk/client-protocol/dist/types/src/shell.d.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spaceid"><code class="tsd-tag">Optional</code><span>space<wbr/>Id</span><a href="#spaceid" 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">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spaceinvitationparam"><span>space<wbr/>Invitation<wbr/>Param</span><a href="#spaceinvitationparam" 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">spaceInvitationParam</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="spacekey"><code class="tsd-tag">Optional</code><span class="deprecated">space<wbr/>Key</span><a href="#spacekey" 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">spaceKey</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-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 spaceId.</p>
15
+ </div></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="target"><code class="tsd-tag">Optional</code><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk/client-protocol/dist/types/src/shell.d.ts:11</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="#deviceinvitationparam"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>device<wbr/>Invitation<wbr/>Param</span></a><a href="#invitationcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invitation<wbr/>Code</span></a><a href="#invitationurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invitation<wbr/>Url</span></a><a href="#invitationurlupdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invitation<wbr/>Url<wbr/>Update</span></a><a href="#layout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layout</span></a><a href="#layoutupdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layout<wbr/>Update</span></a><a href="#setappcontext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>App<wbr/>Context</span></a><a href="#setinvitationurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Invitation<wbr/>Url</span></a><a href="#setlayout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Layout</span></a><a href="#spaceid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Id</span></a><a href="#spaceinvitationparam"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Invitation<wbr/>Param</span></a><a href="#spacekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>space<wbr/>Key</span></a><a href="#target"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</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>