Package com.batch.batch_flutter

Class BatchPluginConfiguration

java.lang.Object
com.batch.batch_flutter.BatchPluginConfiguration
public class BatchPluginConfiguration extends Object
Manages Batch configuration for the flutter plugin. Configuration will be read from the manifest, but can be overridden at app launch.

  • Constructor Details

    • BatchPluginConfiguration

      public BatchPluginConfiguration()

  • Method Details

    • getApiKey

      @Nullable public String getApiKey()
      Get the API key.
      Returns:
      The API key.

    • setAPIKey

      public BatchPluginConfiguration setAPIKey(@Nullable String apiKey)
      Set the API key.
      Parameters:
      apiKey - The API key.
      Returns:
      This BatchPluginConfiguration instance for method chaining.

    • getInitialDoNotDisturbState

      public boolean getInitialDoNotDisturbState()
      Get the initial do not disturb state.
      Returns:
      The initial do not disturb state.

    • setInitialDoNotDisturbState

      public BatchPluginConfiguration setInitialDoNotDisturbState(boolean initialDoNotDisturbState)
      Set the initial do not disturb state.
      Parameters:
      initialDoNotDisturbState - The initial do not disturb state.
      Returns:
      This BatchPluginConfiguration instance for method chaining.

    • isProfileCustomIdMigrationEnabled

      public boolean isProfileCustomIdMigrationEnabled()
      Whether custom id migration is enabled or not.

    • setProfileCustomIdMigrationEnabled

      public BatchPluginConfiguration setProfileCustomIdMigrationEnabled(boolean profileCustomIdMigrationEnabled)
      Whether Batch should automatically identify logged-in user when running the SDK for the first time.

      This mean user with a custom_user_id will be automatically attached a to a Profile and could be targeted within a Project scope.

      Parameters:
      profileCustomIdMigrationEnabled - whether custom id migration is enabled or not.
      Returns:
      This BatchPluginConfiguration instance for method chaining.

    • isProfileCustomDataMigrationEnabled

      public boolean isProfileCustomDataMigrationEnabled()
      Whether custom data migration is enabled or not.

    • setProfileCustomDataMigrationEnabled

      public BatchPluginConfiguration setProfileCustomDataMigrationEnabled(boolean profileCustomDataMigrationEnabled)
      Set whether Batch should automatically attach current installation's data (language/region/customDataAttributes...) to the User's Profile when running the SDK for the first time.
      Parameters:
      profileCustomDataMigrationEnabled - whether custom data migration is enabled or not.
      Returns:
      This BatchPluginConfiguration instance for method chaining.