SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias InstanceGetOrCreateBotRequest

    InstanceGetOrCreateBotRequest: Message<
        "soulfire.v1.InstanceGetOrCreateBotRequest",
    > & {
        account?: MinecraftAccountProto;
        auth: BotAuthentication;
        id: string;
        name: string;
        username?: string;
    }

    Finds a configured account by its SDK name or Minecraft username. Offline accounts need no authentication payload. A new Microsoft account requires the account returned by the device-code authentication flow.

    Type Declaration

    • Optionalaccount?: MinecraftAccountProto

      from field: optional soulfire.v1.MinecraftAccountProto account = 5;

    • auth: BotAuthentication

      from field: soulfire.v1.BotAuthentication auth = 3;

    • id: string

      from field: string id = 1;

    • name: string

      from field: string name = 2;

    • Optionalusername?: string

      Defaults to name for offline accounts. Microsoft usernames come from auth.

      from field: optional string username = 4;

    from message soulfire.v1.InstanceGetOrCreateBotRequest