@dxos/react-client
    Preparing search index...

    Type Alias Invitation

    Invitation: Message<"dxos.client.services.Invitation"> & {
        authCode?: string;
        authMethod: Invitation_AuthMethod;
        created?: Timestamp;
        delegationCredentialId?: PublicKey;
        guestKeypair?: AdmissionKeypair;
        identityKey?: PublicKey;
        invitationId: string;
        kind: Invitation_Kind;
        lifetime?: number;
        multiUse?: boolean;
        persistent?: boolean;
        role?: SpaceMember_Role;
        spaceId?: string;
        spaceKey?: PublicKey;
        state: Invitation_State;
        swarmKey?: PublicKey;
        target?: string;
        timeout?: number;
        type: Invitation_Type;
    }

    Represents the invitation state passed between client and service.

    Type declaration

    • OptionalauthCode?: string

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

      from field: optional string auth_code = 10;

    • authMethod: Invitation_AuthMethod

      / How the invitation is authenticated.

      from field: dxos.client.services.Invitation.AuthMethod auth_method = 4;

    • Optionalcreated?: Timestamp

      from field: optional google.protobuf.Timestamp created = 13;

    • OptionaldelegationCredentialId?: PublicKey

      / Present on Type.DELEGATED invitations.

      from field: optional dxos.keys.PublicKey delegation_credential_id = 17;

    • OptionalguestKeypair?: AdmissionKeypair

      / Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.

      from field: optional dxos.client.services.AdmissionKeypair guest_keypair = 16;

    • OptionalidentityKey?: PublicKey

      / Guest's identity.

      from field: optional dxos.keys.PublicKey identity_key = 8;

    • invitationId: string

      / Local identifier (random).

      from field: string invitation_id = 1;

    • kind: Invitation_Kind

      / Kind of access the invitation will grant.

      from field: dxos.client.services.Invitation.Kind kind = 3;

    • Optionallifetime?: number

      / Number of seconds the host will honor the invitation. 0 means the invitation persists forever. TODO(nf): some feedback mechanism or GC for immortal invitations? TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.

      from field: optional int32 lifetime = 14;

    • OptionalmultiUse?: boolean

      / Whether an invitation can be used multiple times.

      from field: optional bool multi_use = 15;

    • Optionalpersistent?: boolean

      TODO(nf): should these exist elsewhere since they only have meaning to the host? / Host should resume invitation on startup until timeout.

      from field: optional bool persistent = 12;

    • Optionalrole?: SpaceMember_Role

      / Role of the admitted member, defaults to ADMIN.

      from field: optional dxos.halo.credentials.SpaceMember.Role role = 18;

    • OptionalspaceId?: string

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

      from field: optional string space_id = 19;

    • OptionalspaceKey?: PublicKey

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

      from field: optional dxos.keys.PublicKey space_key = 9;

    • state: Invitation_State

      / Local state.

      from field: dxos.client.services.Invitation.State state = 6;

    • OptionalswarmKey?: PublicKey

      / Swarm rendezvous (random).

      from field: dxos.keys.PublicKey swarm_key = 5;

    • Optionaltarget?: string

      / Path or identifier to navigate to after successful authentication.

      from field: optional string target = 11;

    • Optionaltimeout?: number

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

      from field: optional int32 timeout = 7;

    • type: Invitation_Type

      / Determines the behavior of the invitation.

      from field: dxos.client.services.Invitation.Type type = 2;

    from message dxos.client.services.Invitation

    Settings

    Member Visibility