@dxos/react-client 0.8.3 → 0.8.4-main.84f28bd
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.
- package/.swc/plugins/v7_linux_x86_64_13.0.0/f45bdff002284d9e8f9ef3f0be909de12da36c049cbcf261ac78fc00abb09a2d +0 -0
- package/dist/lib/browser/{chunk-72QD3PXL.mjs → chunk-AAR7V3KL.mjs} +14 -14
- package/dist/lib/browser/{chunk-AL2CUQ46.mjs → chunk-O5SEVDJG.mjs} +4 -4
- package/dist/lib/browser/devtools/index.mjs +5 -5
- package/dist/lib/browser/echo/index.mjs +15 -15
- package/dist/lib/browser/echo/index.mjs.map +3 -3
- package/dist/lib/browser/halo/index.mjs +9 -9
- package/dist/lib/browser/index.mjs +2 -2
- package/dist/lib/browser/invitations/index.mjs +1 -1
- package/dist/lib/browser/mesh/index.mjs +3 -3
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +6 -6
- package/dist/lib/browser/worker.mjs +1 -1
- package/dist/lib/node-esm/{chunk-UYJUBYMU.mjs → chunk-TU2JJLZK.mjs} +4 -4
- package/dist/lib/node-esm/{chunk-NBTZZNQ5.mjs → chunk-ZTD6HPV2.mjs} +14 -14
- package/dist/lib/node-esm/devtools/index.mjs +5 -5
- package/dist/lib/node-esm/echo/index.mjs +15 -15
- package/dist/lib/node-esm/echo/index.mjs.map +3 -3
- package/dist/lib/node-esm/halo/index.mjs +9 -9
- package/dist/lib/node-esm/index.mjs +2 -2
- package/dist/lib/node-esm/invitations/index.mjs +1 -1
- package/dist/lib/node-esm/mesh/index.mjs +3 -3
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +6 -6
- package/dist/lib/node-esm/worker.mjs +1 -1
- package/dist/types/src/playwright/{playwright.config.d.cts → playwright.config.d.ts} +1 -1
- package/dist/types/src/playwright/playwright.config.d.ts.map +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/moon.yml +19 -0
- package/package.json +25 -25
- package/src/echo/useSyncState.ts +2 -2
- package/src/playwright/playwright.config.ts +17 -0
- package/src/playwright/smoke.spec.ts +4 -6
- package/typedoc/assets/hierarchy.js +1 -1
- package/typedoc/assets/navigation.js +1 -1
- package/typedoc/assets/search.js +1 -1
- package/typedoc/classes/echo.PropertiesType.html +3 -3
- package/typedoc/classes/halo.KeyStore.html +2 -2
- package/typedoc/classes/index.AlreadyJoinedError.html +2 -2
- package/typedoc/classes/index.ApiError.html +2 -2
- package/typedoc/classes/index.CancelledError.html +2 -2
- package/typedoc/classes/index.Client.html +1 -1
- package/typedoc/classes/index.DataCorruptionError.html +2 -2
- package/typedoc/classes/index.DatabaseError.html +2 -2
- package/typedoc/classes/index.EntityNotFoundError.html +2 -2
- package/typedoc/classes/index.IdentityNotInitializedError.html +2 -2
- package/typedoc/classes/index.InvalidConfigError.html +2 -2
- package/typedoc/classes/index.InvalidInvitationError.html +2 -2
- package/typedoc/classes/index.InvalidInvitationExtensionRoleError.html +2 -2
- package/typedoc/classes/index.InvalidStorageVersionError.html +2 -2
- package/typedoc/classes/index.RemoteServiceConnectionError.html +2 -2
- package/typedoc/classes/index.RemoteServiceConnectionTimeout.html +2 -2
- package/typedoc/classes/index.RpcClosedError.html +2 -2
- package/typedoc/classes/index.RpcNotOpenError.html +2 -2
- package/typedoc/classes/index.SystemError.html +2 -2
- package/typedoc/classes/index.UnknownModelError.html +2 -2
- package/typedoc/classes/invitations.AuthenticatingInvitationObservable.html +1 -1
- package/typedoc/classes/invitations.CancellableInvitationObservable.html +1 -1
- package/typedoc/enums/devtools.KeyType.html +2 -2
- package/typedoc/enums/echo.HaloSpaceMember.Role.html +2 -2
- package/typedoc/enums/echo.IndexKind.Kind.html +2 -2
- package/typedoc/enums/echo.QueryOptions.DataLocation.html +2 -2
- package/typedoc/enums/echo.QueryOptions.ShowDeletedOption.html +2 -2
- package/typedoc/enums/echo.SpaceMember.PresenceState.html +2 -2
- package/typedoc/enums/echo.SpaceState.html +2 -2
- package/typedoc/enums/echo.TextKind.html +2 -2
- package/typedoc/enums/halo.Device.PresenceState.html +2 -2
- package/typedoc/enums/halo.DeviceKind.html +2 -2
- package/typedoc/enums/halo.DeviceType.html +2 -2
- package/typedoc/enums/index.ShellDisplay.html +2 -2
- package/typedoc/enums/index.ShellLayout.html +2 -2
- package/typedoc/enums/index.SystemStatus.html +2 -2
- package/typedoc/enums/invitations.Invitation.AuthMethod.html +2 -2
- package/typedoc/enums/invitations.Invitation.Kind.html +2 -2
- package/typedoc/enums/invitations.Invitation.State.html +2 -2
- package/typedoc/enums/invitations.Invitation.Type.html +2 -2
- package/typedoc/enums/mesh.ConnectionState.html +2 -2
- package/typedoc/functions/devtools.useDevtools.html +1 -1
- package/typedoc/functions/devtools.useStream.html +1 -1
- package/typedoc/functions/echo.useMembers.html +1 -1
- package/typedoc/functions/echo.useQueue.html +1 -1
- package/typedoc/functions/echo.useSchema.html +1 -1
- package/typedoc/functions/echo.useSpace.html +1 -1
- package/typedoc/functions/echo.useSpaceInvitation.html +1 -1
- package/typedoc/functions/echo.useSpaceInvitations.html +1 -1
- package/typedoc/functions/echo.useSpaceSyncState.html +1 -1
- package/typedoc/functions/echo.useSpaces.html +1 -1
- package/typedoc/functions/echo.useSubscription.html +1 -1
- package/typedoc/functions/echo.useSyncState.html +1 -1
- package/typedoc/functions/halo.useContacts.html +1 -1
- package/typedoc/functions/halo.useCredentials.html +1 -1
- package/typedoc/functions/halo.useDevices.html +1 -1
- package/typedoc/functions/halo.useHaloInvitation.html +1 -1
- package/typedoc/functions/halo.useHaloInvitations.html +1 -1
- package/typedoc/functions/halo.useIdentity.html +1 -1
- package/typedoc/functions/halo.useKeyStore.html +1 -1
- package/typedoc/functions/index.AgentHostingProvider.html +1 -1
- package/typedoc/functions/index.useAgentHostingClient.html +1 -1
- package/typedoc/functions/index.useClient.html +1 -1
- package/typedoc/functions/index.useClientStatus.html +1 -1
- package/typedoc/functions/index.useConfig.html +1 -1
- package/typedoc/functions/index.useShell.html +1 -1
- package/typedoc/functions/index.useShellDisplay.html +1 -1
- package/typedoc/functions/index.useStatus.html +1 -1
- package/typedoc/functions/invitations.useInvitationStatus.html +1 -1
- package/typedoc/functions/mesh.useNetworkStatus.html +1 -1
- package/typedoc/hierarchy.html +1 -1
- package/typedoc/interfaces/devtools.DevtoolsHost.html +2 -2
- package/typedoc/interfaces/echo.EchoDatabase.html +15 -10
- package/typedoc/interfaces/echo.Expando.html +1 -1
- package/typedoc/interfaces/echo.HaloSpaceMember.html +4 -4
- package/typedoc/interfaces/echo.IndexKind.html +2 -2
- package/typedoc/interfaces/echo.QueryOptions.html +8 -8
- package/typedoc/interfaces/echo.Space.html +11 -14
- package/typedoc/interfaces/echo.SpaceMember.html +2 -2
- package/typedoc/interfaces/echo.SpaceSyncState.PeerState.html +6 -6
- package/typedoc/interfaces/echo.SpaceSyncState.html +2 -2
- package/typedoc/interfaces/echo.TypedObject.html +3 -3
- package/typedoc/interfaces/halo.Contact.html +3 -3
- package/typedoc/interfaces/halo.Credential.html +5 -5
- package/typedoc/interfaces/halo.Device.html +3 -3
- package/typedoc/interfaces/halo.Identity.html +4 -4
- package/typedoc/interfaces/index.AppContextRequest.html +6 -6
- package/typedoc/interfaces/index.InvitationUrlRequest.html +4 -4
- package/typedoc/interfaces/index.LayoutRequest.html +6 -6
- package/typedoc/interfaces/invitations.Invitation.html +20 -20
- package/typedoc/interfaces/mesh.GossipMessage.html +3 -3
- package/typedoc/interfaces/mesh.NetworkStatus.Signal.html +2 -2
- package/typedoc/interfaces/mesh.NetworkStatus.html +2 -2
- package/typedoc/modules/echo.html +1 -1
- package/typedoc/types/echo.Live.html +1 -1
- package/typedoc/types/echo.UseQueueOptions.html +2 -2
- package/typedoc/types/echo.UseSpacesParams.html +2 -2
- package/typedoc/types/index.AgentHostingProviderProps.html +2 -2
- package/typedoc/types/index.ClientContextProps.html +2 -2
- package/typedoc/types/index.ClientProviderProps.html +1 -1
- package/typedoc/types/invitations.InvitationAction.html +1 -1
- package/typedoc/types/invitations.InvitationResult.html +2 -2
- package/typedoc/types/invitations.InvitationStatus.html +2 -2
- package/typedoc/variables/echo.RefArray.html +1 -1
- package/typedoc/variables/echo.internalDecodeReference.html +2 -1
- package/typedoc/variables/echo.isLiveObject.html +3 -2
- package/typedoc/variables/echo.useQuery.html +1 -1
- package/typedoc/variables/index.AgentHostingContext.html +1 -1
- package/typedoc/variables/index.ClientProvider.html +1 -1
- package/typedoc/variables/index.DXOS_VERSION.html +1 -1
- package/vitest.config.ts +1 -1
- package/README.yml +0 -33
- package/dist/lib/node/chunk-5RUIFUEC.cjs +0 -334
- package/dist/lib/node/chunk-5RUIFUEC.cjs.map +0 -7
- package/dist/lib/node/chunk-FYOAVV65.cjs +0 -188
- package/dist/lib/node/chunk-FYOAVV65.cjs.map +0 -7
- package/dist/lib/node/devtools/index.cjs +0 -62
- package/dist/lib/node/devtools/index.cjs.map +0 -7
- package/dist/lib/node/echo/index.cjs +0 -302
- package/dist/lib/node/echo/index.cjs.map +0 -7
- package/dist/lib/node/halo/index.cjs +0 -123
- package/dist/lib/node/halo/index.cjs.map +0 -7
- package/dist/lib/node/index.cjs +0 -55
- package/dist/lib/node/index.cjs.map +0 -7
- package/dist/lib/node/invitations/index.cjs +0 -39
- package/dist/lib/node/invitations/index.cjs.map +0 -7
- package/dist/lib/node/mesh/index.cjs +0 -37
- package/dist/lib/node/mesh/index.cjs.map +0 -7
- package/dist/lib/node/meta.json +0 -1
- package/dist/lib/node/testing/index.cjs +0 -278
- package/dist/lib/node/testing/index.cjs.map +0 -7
- package/dist/lib/node/worker.cjs +0 -23
- package/dist/lib/node/worker.cjs.map +0 -7
- package/dist/types/src/playwright/playwright.config.d.cts.map +0 -1
- package/project.json +0 -40
- package/src/playwright/playwright.config.cts +0 -18
- package/typedoc/enums/echo.ResultFormat.html +0 -10
- package/typedoc/variables/echo.makeRef.html +0 -2
- package/typedoc/variables/echo.refFromDXN.html +0 -2
- /package/dist/lib/browser/{chunk-72QD3PXL.mjs.map → chunk-AAR7V3KL.mjs.map} +0 -0
- /package/dist/lib/browser/{chunk-AL2CUQ46.mjs.map → chunk-O5SEVDJG.mjs.map} +0 -0
- /package/dist/lib/node-esm/{chunk-UYJUBYMU.mjs.map → chunk-TU2JJLZK.mjs.map} +0 -0
- /package/dist/lib/node-esm/{chunk-NBTZZNQ5.mjs.map → chunk-ZTD6HPV2.mjs.map} +0 -0
|
@@ -1,9 +1,9 @@
|
|
|
1
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
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/
|
|
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/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
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
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
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/
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
9
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/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/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/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>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
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
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/
|
|
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/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
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
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
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>
|
|
@@ -10,20 +10,20 @@ file://./../../dxos/iframe.proto</p>
|
|
|
10
10
|
<ul>
|
|
11
11
|
<li>proto3_optional = true</li>
|
|
12
12
|
</ul>
|
|
13
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
14
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
13
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/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/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
15
|
<p>Options:</p>
|
|
16
16
|
<ul>
|
|
17
17
|
<li>proto3_optional = true</li>
|
|
18
18
|
</ul>
|
|
19
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
19
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/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
20
|
<p>Options:</p>
|
|
21
21
|
<ul>
|
|
22
22
|
<li>proto3_optional = true</li>
|
|
23
23
|
</ul>
|
|
24
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/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
25
|
<p>Options:</p>
|
|
26
26
|
<ul>
|
|
27
27
|
<li>proto3_optional = true</li>
|
|
28
28
|
</ul>
|
|
29
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
29
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/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>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
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>Invitation | @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/invitations.html">invitations</a></li><li><a href="" aria-current="page">Invitation</a></li></ul><h1>Interface Invitation</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents the invitation state passed between client and service.</p>
|
|
2
2
|
<p>Defined in:
|
|
3
3
|
file://./../../../dxos/client/invitation.proto</p>
|
|
4
|
-
</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">Invitation</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#authcode">authCode</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="#authmethod">authMethod</a><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.AuthMethod.html" class="tsd-signature-type tsd-kind-enum">AuthMethod</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#created">created</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#delegationcredentialid">delegationCredentialId</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="#guestkeypair">guestKeypair</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AdmissionKeypair</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#identitykey">identityKey</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="#invitationid">invitationId</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="#kind">kind</a><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Kind.html" class="tsd-signature-type tsd-kind-enum">Kind</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lifetime">lifetime</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#multiuse">multiUse</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="#persistent">persistent</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="#role">role</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/echo.HaloSpaceMember.Role.html" class="tsd-signature-type tsd-kind-enum">Role</a><span class="tsd-signature-symbol">;</span><br/> <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="#state">state</a><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.State.html" class="tsd-signature-type tsd-kind-enum">State</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#swarmkey">swarmKey</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/> <a class="tsd-kind-property" href="#timeout">timeout</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
4
|
+
</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">Invitation</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#authcode">authCode</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="#authmethod">authMethod</a><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.AuthMethod.html" class="tsd-signature-type tsd-kind-enum">AuthMethod</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#created">created</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#delegationcredentialid">delegationCredentialId</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="#guestkeypair">guestKeypair</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AdmissionKeypair</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#identitykey">identityKey</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="#invitationid">invitationId</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="#kind">kind</a><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Kind.html" class="tsd-signature-type tsd-kind-enum">Kind</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lifetime">lifetime</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#multiuse">multiUse</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="#persistent">persistent</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="#role">role</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/echo.HaloSpaceMember.Role.html" class="tsd-signature-type tsd-kind-enum">Role</a><span class="tsd-signature-symbol">;</span><br/> <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="#state">state</a><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.State.html" class="tsd-signature-type tsd-kind-enum">State</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#swarmkey">swarmKey</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/> <a class="tsd-kind-property" href="#timeout">timeout</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:49</li><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:162</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="#authcode" 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>auth<wbr/>Code?</span></a>
|
|
5
5
|
<a href="#authmethod" 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>auth<wbr/>Method</span></a>
|
|
6
6
|
<a href="#created" 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>created?</span></a>
|
|
7
7
|
<a href="#delegationcredentialid" 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>delegation<wbr/>Credential<wbr/>Id?</span></a>
|
|
@@ -25,68 +25,68 @@ file://./../../../dxos/client/invitation.proto</p>
|
|
|
25
25
|
<ul>
|
|
26
26
|
<li>proto3_optional = true</li>
|
|
27
27
|
</ul>
|
|
28
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
29
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
28
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:101</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="authmethod"><span>auth<wbr/>Method</span><a href="#authmethod" 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">authMethod</span><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.AuthMethod.html" class="tsd-signature-type tsd-kind-enum">AuthMethod</a></div><div class="tsd-comment tsd-typography"><p>How the invitation is authenticated.</p>
|
|
29
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:65</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="created"><code class="tsd-tag">Optional</code><span>created</span><a href="#created" 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">created</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span></div><div class="tsd-comment tsd-typography"><p>Options:</p>
|
|
30
30
|
<ul>
|
|
31
31
|
<li>proto3_optional = true</li>
|
|
32
32
|
</ul>
|
|
33
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
33
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:120</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delegationcredentialid"><code class="tsd-tag">Optional</code><span>delegation<wbr/>Credential<wbr/>Id</span><a href="#delegationcredentialid" 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">delegationCredentialId</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>Present on Type.DELEGATED invitations.</p>
|
|
34
34
|
<p>Options:</p>
|
|
35
35
|
<ul>
|
|
36
36
|
<li>proto3_optional = true</li>
|
|
37
37
|
</ul>
|
|
38
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
38
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:146</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="guestkeypair"><code class="tsd-tag">Optional</code><span>guest<wbr/>Keypair</span><a href="#guestkeypair" 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">guestKeypair</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AdmissionKeypair</span></div><div class="tsd-comment tsd-typography"><p>Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.</p>
|
|
39
39
|
<p>Options:</p>
|
|
40
40
|
<ul>
|
|
41
41
|
<li>proto3_optional = true</li>
|
|
42
42
|
</ul>
|
|
43
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
43
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:139</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="identitykey"><code class="tsd-tag">Optional</code><span>identity<wbr/>Key</span><a href="#identitykey" 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">identityKey</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>Guest's identity.</p>
|
|
44
44
|
<p>Options:</p>
|
|
45
45
|
<ul>
|
|
46
46
|
<li>proto3_optional = true</li>
|
|
47
47
|
</ul>
|
|
48
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
49
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
50
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
48
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:87</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invitationid"><span>invitation<wbr/>Id</span><a href="#invitationid" 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">invitationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Local identifier (random).</p>
|
|
49
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:53</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="kind"><span>kind</span><a href="#kind" 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">kind</span><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Kind.html" class="tsd-signature-type tsd-kind-enum">Kind</a></div><div class="tsd-comment tsd-typography"><p>Kind of access the invitation will grant.</p>
|
|
50
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:61</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lifetime"><code class="tsd-tag">Optional</code><span>lifetime</span><a href="#lifetime" 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">lifetime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Options:</p>
|
|
51
51
|
<ul>
|
|
52
52
|
<li>proto3_optional = true</li>
|
|
53
53
|
</ul>
|
|
54
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
54
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:125</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="multiuse"><code class="tsd-tag">Optional</code><span>multi<wbr/>Use</span><a href="#multiuse" 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">multiUse</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether an invitation can be used multiple times.</p>
|
|
55
55
|
<p>Options:</p>
|
|
56
56
|
<ul>
|
|
57
57
|
<li>proto3_optional = true</li>
|
|
58
58
|
</ul>
|
|
59
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
59
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:132</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="persistent"><code class="tsd-tag">Optional</code><span>persistent</span><a href="#persistent" 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">persistent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Host should resume invitation on startup until timeout.</p>
|
|
60
60
|
<p>Options:</p>
|
|
61
61
|
<ul>
|
|
62
62
|
<li>proto3_optional = true</li>
|
|
63
63
|
</ul>
|
|
64
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
64
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:115</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="role"><code class="tsd-tag">Optional</code><span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/echo.HaloSpaceMember.Role.html" class="tsd-signature-type tsd-kind-enum">Role</a></div><div class="tsd-comment tsd-typography"><p>Role of the admitted member, defaults to ADMIN.</p>
|
|
65
65
|
<p>Options:</p>
|
|
66
66
|
<ul>
|
|
67
67
|
<li>proto3_optional = true</li>
|
|
68
68
|
</ul>
|
|
69
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
69
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:153</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 a the space to join (only present if kind is SPACE).</p>
|
|
70
70
|
<p>Options:</p>
|
|
71
71
|
<ul>
|
|
72
72
|
<li>proto3_optional = true</li>
|
|
73
73
|
</ul>
|
|
74
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
74
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:160</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>Space to join (only present if kind is SPACE).</p>
|
|
75
75
|
<p>Options:</p>
|
|
76
76
|
<ul>
|
|
77
77
|
<li>proto3_optional = true</li>
|
|
78
78
|
</ul>
|
|
79
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
80
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
81
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
79
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:94</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/invitations.Invitation.State.html" class="tsd-signature-type tsd-kind-enum">State</a></div><div class="tsd-comment tsd-typography"><p>Local state.</p>
|
|
80
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:73</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="swarmkey"><span>swarm<wbr/>Key</span><a href="#swarmkey" 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">swarmKey</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>Swarm rendezvous (random).</p>
|
|
81
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:69</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>Path or identifier to navigate to after successful authentication.</p>
|
|
82
82
|
<p>Options:</p>
|
|
83
83
|
<ul>
|
|
84
84
|
<li>proto3_optional = true</li>
|
|
85
85
|
</ul>
|
|
86
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
86
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:108</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="timeout"><code class="tsd-tag">Optional</code><span>timeout</span><a href="#timeout" 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">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Timeout for guest to complete invitation once connected (ms).</p>
|
|
87
87
|
<p>Options:</p>
|
|
88
88
|
<ul>
|
|
89
89
|
<li>proto3_optional = true</li>
|
|
90
90
|
</ul>
|
|
91
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
92
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/
|
|
91
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:80</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../modules/invitations.Invitation.html" class="tsd-signature-type tsd-kind-namespace">Invitation</a><span class="tsd-signature-symbol">.</span><a href="../enums/invitations.Invitation.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a></div><div class="tsd-comment tsd-typography"><p>Determines the behavior of the invitation.</p>
|
|
92
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/protocols/dist/src/proto/gen/dxos/client/services.d.ts:57</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="#authcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth<wbr/>Code</span></a><a href="#authmethod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth<wbr/>Method</span></a><a href="#created"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created</span></a><a href="#delegationcredentialid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delegation<wbr/>Credential<wbr/>Id</span></a><a href="#guestkeypair"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>guest<wbr/>Keypair</span></a><a href="#identitykey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>identity<wbr/>Key</span></a><a href="#invitationid"><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/>Id</span></a><a href="#kind"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kind</span></a><a href="#lifetime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lifetime</span></a><a href="#multiuse"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>multi<wbr/>Use</span></a><a href="#persistent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>persistent</span></a><a href="#role"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a><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="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#swarmkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swarm<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><a href="#timeout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>
|