Interface SettingsPageOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SettingsPage, SettingsPage.Builder
@Generated public interface SettingsPageOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getId

      String getId()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Returns:
      The bytes for id.

    • hasOwningPluginId

      boolean hasOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Returns:
      Whether the owningPluginId field is set.

    • getOwningPluginId

      String getOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Returns:
      The owningPluginId.

    • getOwningPluginIdBytes

      com.google.protobuf.ByteString getOwningPluginIdBytes()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Returns:
      The bytes for owningPluginId.

    • getPageName

      String getPageName()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Returns:
      The pageName.

    • getPageNameBytes

      com.google.protobuf.ByteString getPageNameBytes()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Returns:
      The bytes for pageName.

    • getEntriesList

      List<SettingsEntryIdentifier> getEntriesList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntries

      SettingsEntryIdentifier getEntries(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesCount

      int getEntriesCount()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesOrBuilderList

      List<? extends SettingsEntryIdentifierOrBuilder> getEntriesOrBuilderList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getEntriesOrBuilder

      SettingsEntryIdentifierOrBuilder getEntriesOrBuilder(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;

    • getIconId

      String getIconId()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Returns:
      The iconId.

    • getIconIdBytes

      com.google.protobuf.ByteString getIconIdBytes()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Returns:
      The bytes for iconId.

    • hasEnabledIdentifier

      boolean hasEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Returns:
      Whether the enabledIdentifier field is set.

    • getEnabledIdentifier

      SettingsEntryIdentifier getEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Returns:
      The enabledIdentifier.

    • getEnabledIdentifierOrBuilder

      SettingsEntryIdentifierOrBuilder getEnabledIdentifierOrBuilder()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;