Interface Invitation

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/services.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.

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.

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).

timeout

Type: number

Timeout (ms).

Options:

• proto3_optional = true

type

Type: Type

Determines the behavior of the invitation.