SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias SdkHandshakeResponse

    SdkHandshakeResponse: Message<"soulfire.v1.SdkHandshakeResponse"> & {
        apiVersion?: SdkApiVersion;
        branchName: string;
        capabilities: SdkCapability[];
        commitHash: string;
        identity?: SdkIdentity;
        limits: SdkLimit[];
        nativeMinecraftVersion: string;
        plugins: PluginApiDescriptor[];
        serverId: string;
        soulfireVersion: string;
        supportedMinecraftVersions: string[];
        transports: SdkTransport[];
    }

    Server metadata and negotiated features returned before an SDK is ready.

    Type Declaration

    • OptionalapiVersion?: SdkApiVersion

      from field: soulfire.v1.SdkApiVersion api_version = 5;

    • branchName: string

      from field: string branch_name = 4;

    • capabilities: SdkCapability[]

      from field: repeated soulfire.v1.SdkCapability capabilities = 9;

    • commitHash: string

      from field: string commit_hash = 3;

    • Optionalidentity?: SdkIdentity

      from field: soulfire.v1.SdkIdentity identity = 12;

    • limits: SdkLimit[]

      from field: repeated soulfire.v1.SdkLimit limits = 11;

    • nativeMinecraftVersion: string

      from field: string native_minecraft_version = 6;

    • plugins: PluginApiDescriptor[]

      from field: repeated soulfire.v1.PluginApiDescriptor plugins = 10;

    • serverId: string

      from field: string server_id = 1;

    • soulfireVersion: string

      from field: string soulfire_version = 2;

    • supportedMinecraftVersions: string[]

      from field: repeated string supported_minecraft_versions = 7;

    • transports: SdkTransport[]

      from field: repeated soulfire.v1.SdkTransport transports = 8;

    from message soulfire.v1.SdkHandshakeResponse

    Settings
    Member Visibility