SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias InstanceInfo

    InstanceInfo: Message<"soulfire.v1.InstanceInfo"> & {
        botSummary?: BotFleetSummary;
        config?: InstanceConfig;
        friendlyName: string;
        icon: string;
        instancePermissions: InstancePermissionState[];
        instanceSettings: SettingsPage[];
        lastModified?: Timestamp;
        plugins: ServerPlugin[];
        settingsDefinitions: SettingsDefinition[];
    }

    Contains comprehensive information about an instance including its configuration, state, permissions, and available settings.

    Type Declaration

    • OptionalbotSummary?: BotFleetSummary

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

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

    • Optionalconfig?: InstanceConfig

      The complete configuration of the instance including settings, accounts, and proxies.

      from field: soulfire.v1.InstanceConfig config = 2;

    • friendlyName: string

      The human-readable name of the instance.

      from field: string friendly_name = 1;

    • icon: string

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

      from field: string icon = 5;

    • instancePermissions: InstancePermissionState[]

      The permissions the current user has on this instance.

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

    • instanceSettings: SettingsPage[]

      Pages that group settings together for UI rendering. References settings by their identifiers from settings_definitions.

      from field: repeated soulfire.v1.SettingsPage instance_settings = 6;

    • OptionallastModified?: Timestamp

      Timestamp of when the configuration was last modified. Used for conditional requests via if_modified_since.

      from field: google.protobuf.Timestamp last_modified = 9;

    • plugins: ServerPlugin[]

      List of plugins registered with this instance.

      from field: repeated soulfire.v1.ServerPlugin plugins = 7;

    • settingsDefinitions: SettingsDefinition[]

      All available settings definitions that can be rendered by identifier. These define the schema and UI configuration for each setting.

      from field: repeated soulfire.v1.SettingsDefinition settings_definitions = 8;

    from message soulfire.v1.InstanceInfo

    Settings
    Member Visibility