@dxos/client
    Preparing search index...

    Interface Invitation

    Represents the invitation state passed between client and service.

    Defined in: file://./../../../dxos/client/invitation.proto

    interface Invitation {
        authCode?: string;
        authMethod: AuthMethod;
        created?: Date;
        delegationCredentialId?: PublicKey;
        guestKeypair?: AdmissionKeypair;
        identityKey?: PublicKey;
        invitationId: string;
        kind: Invitation.Kind;
        lifetime?: number;
        multiUse?: boolean;
        persistent?: boolean;
        role?: Role;
        spaceId?: string;
        spaceKey?: PublicKey;
        state: State;
        swarmKey: PublicKey;
        target?: string;
        timeout?: number;
        type: Invitation.Type;
    }
    Index

    Properties

    authCode? authMethod created? delegationCredentialId? guestKeypair? identityKey? invitationId kind lifetime? multiUse? persistent? role? spaceId? spaceKey? state swarmKey target? timeout? type

    Properties

    authCode?: string

    Authentication code created by host (only present if auth_method is SHARED_SECRET).

    Options:

    • proto3_optional = true
    authMethod: AuthMethod

    How the invitation is authenticated.

    created?: Date

    Options:

    • proto3_optional = true
    delegationCredentialId?: PublicKey

    Present on Type.DELEGATED invitations.

    Options:

    • proto3_optional = true
    guestKeypair?: AdmissionKeypair

    Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.

    Options:

    • proto3_optional = true
    identityKey?: PublicKey

    Guest's identity.

    Options:

    • proto3_optional = true
    invitationId: string

    Local identifier (random).

    kind: Invitation.Kind

    Kind of access the invitation will grant.

    lifetime?: number

    Options:

    • proto3_optional = true
    multiUse?: boolean

    Whether an invitation can be used multiple times.

    Options:

    • proto3_optional = true
    persistent?: boolean

    Host should resume invitation on startup until timeout.

    Options:

    • proto3_optional = true
    role?: Role

    Role of the admitted member, defaults to ADMIN.

    Options:

    • proto3_optional = true
    spaceId?: string

    Id of a the space to join (only present if kind is SPACE).

    Options:

    • proto3_optional = true
    spaceKey?: PublicKey

    Space to join (only present if kind is SPACE).

    Options:

    • proto3_optional = true
    state: State

    Local state.

    swarmKey: PublicKey

    Swarm rendezvous (random).

    target?: string

    Path or identifier to navigate to after successful authentication.

    Options:

    • proto3_optional = true
    timeout?: number

    Timeout for guest to complete invitation once connected (ms).

    Options:

    • proto3_optional = true
    type: Invitation.Type

    Determines the behavior of the invitation.

    Settings

    Member Visibility

    On This Page

    Properties