Interface Invitation
Invitation
Interface Declared in
packages/core/protocols/dist/esm/src/proto/gen/dxos/client/services.d.ts
Represents the invitation state passed between client and service.
Defined in: file://./../../../dxos/client/invitation.proto
Properties
authCode
Type: string
Authentication code created by host (only present if auth_method is SHARED_SECRET).
Options:
- proto3_optional = true
authMethod
Type: AuthMethod
How the invitation is authenticated.
created
Type: Date
Options:
- proto3_optional = true
delegationCredentialId
Type: PublicKey
Present on Type.DELEGATED invitations.
Options:
- proto3_optional = true
guestKeypair
Type: AdmissionKeypair
Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
Options:
- proto3_optional = true
identityKey
Type: PublicKey
Guest's identity.
Options:
- proto3_optional = true
invitationId
Type: string
Local identifier (random).
kind
Type: Kind
Kind of access the invitation will grant.
lifetime
Type: number
Options:
- proto3_optional = true
multiUse
Type: boolean
Whether an invitation can be used multiple times.
Options:
- proto3_optional = true
persistent
Type: boolean
Host should resume invitation on startup until timeout.
Options:
- proto3_optional = true
role
Type: Role
Role of the admitted member, defaults to ADMIN.
Options:
- proto3_optional = true
spaceKey
Type: PublicKey
Space to join (only present if kind is SPACE).
Options:
- proto3_optional = true
state
Type: State
Local state.
swarmKey
Type: PublicKey
Swarm rendezvous (random).
target
Type: string
Path or identifier to navigate to after successful authentication.
Options:
- proto3_optional = true
timeout
Type: number
Timeout for guest to complete invitation once connected (ms).
Options:
- proto3_optional = true
type
Type: Type
Determines the behavior of the invitation.