SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias InstanceListResponse_Instance

    InstanceListResponse_Instance: Message<
        "soulfire.v1.InstanceListResponse.Instance",
    > & {
        botSummary?: BotFleetSummary;
        friendlyName: string;
        icon: string;
        id: string;
        instancePermissions: InstancePermissionState[];
    }

    Summary information about a single instance.

    Type Declaration

    • OptionalbotSummary?: BotFleetSummary

      Aggregate desired and runtime state for the instance's bots.

      from field: soulfire.v1.BotFleetSummary bot_summary = 6;

    • friendlyName: string

      The human-readable name of the instance.

      from field: string friendly_name = 2;

    • icon: string

      The icon identifier for the instance (used for UI display).

      from field: string icon = 5;

    • id: string

      The unique identifier (UUID) of the instance.

      from field: string id = 1;

    • instancePermissions: InstancePermissionState[]

      The permissions the current user has on this instance. Each permission indicates whether a specific action is allowed.

      from field: repeated soulfire.v1.InstancePermissionState instance_permissions = 4;

    from message soulfire.v1.InstanceListResponse.Instance