All Implemented Interfaces:


public class PostHogConfig

The SDK Config

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`PostHogConfig.Builder`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`DEFAULT_US_HOST`
`public final static String`	`DEFAULT_US_ASSETS_HOST`
`public final static String`	`DEFAULT_HOST`
`public final static String`	`DEFAULT_EU_HOST`
`public final static String`	`DEFAULT_EU_ASSETS_HOST`
`public final static Integer`	`DEFAULT_FLUSH_AT`
`public final static Integer`	`DEFAULT_MAX_QUEUE_SIZE`
`public final static Integer`	`DEFAULT_MAX_BATCH_SIZE`
`public final static Integer`	`DEFAULT_FLUSH_INTERVAL_SECONDS`
`public final static Integer`	`DEFAULT_FEATURE_FLAG_CACHE_SIZE`
`public final static Integer`	`DEFAULT_FEATURE_FLAG_CACHE_MAX_AGE_MS`
`public final static Integer`	`DEFAULT_FEATURE_FLAG_CALLED_CACHE_SIZE`
`public final static Integer`	`DEFAULT_POLL_INTERVAL_SECONDS`
`private final String`	`apiKey`
`private final String`	`host`
`private Boolean`	`debug`
`private Boolean`	`sendFeatureFlagEvent`
`private Boolean`	`preloadFeatureFlags`
`private Boolean`	`remoteConfig`
`private Integer`	`flushAt`
`private Integer`	`maxQueueSize`
`private Integer`	`maxBatchSize`
`private Integer`	`flushIntervalSeconds`
`private PostHogEncryption`	`encryption`
`private PostHogOnFeatureFlags`	`onFeatureFlags`
`private Proxy`	`proxy`
`private Integer`	`featureFlagCacheSize`
`private Integer`	`featureFlagCacheMaxAgeMs`
`private Integer`	`featureFlagCalledCacheSize`
`private Boolean`	`localEvaluation`
`private String`	`personalApiKey`
`private Integer`	`pollIntervalSeconds`
`private List<String>`	`evaluationContexts`

Constructor Summary

Constructors
Constructor	Description
PostHogConfig(String apiKey, String host, Boolean debug, Boolean sendFeatureFlagEvent, Boolean preloadFeatureFlags, Boolean remoteConfig, Integer flushAt, Integer maxQueueSize, Integer maxBatchSize, Integer flushIntervalSeconds, PostHogEncryption encryption, PostHogOnFeatureFlags onFeatureFlags, Proxy proxy, Integer featureFlagCacheSize, Integer featureFlagCacheMaxAgeMs, Integer featureFlagCalledCacheSize, Boolean localEvaluation, String personalApiKey, Integer pollIntervalSeconds, List<String> evaluationContexts)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getApiKey()`	The PostHog API Key
`final String`	`getHost()`	The PostHog Host Defaults to https://us.i.posthog.com EU Host: https://eu.i.posthog.
`final Boolean`	`getDebug()`	Logs the debug logs to the logger if enabled Defaults to false
`final Unit`	`setDebug(Boolean debug)`	Logs the debug logs to the logger if enabled Defaults to false
`final Boolean`	`getSendFeatureFlagEvent()`	Send a $feature_flag_called event when a feature flag is used automatically Used by experimentsDefaults to true
`final Unit`	`setSendFeatureFlagEvent(Boolean sendFeatureFlagEvent)`	Send a $feature_flag_called event when a feature flag is used automatically Used by experimentsDefaults to true
`final Boolean`	`getPreloadFeatureFlags()`	Preload feature flags automatically Docs https://posthog.com/docs/feature-flags and https://posthog.
`final Unit`	`setPreloadFeatureFlags(Boolean preloadFeatureFlags)`	Preload feature flags automatically Docs https://posthog.com/docs/feature-flags and https://posthog.
`final Boolean`	`getRemoteConfig()`	Preload PostHog remote config automatically Defaults to true
`final Unit`	`setRemoteConfig(@Deprecated(message = "Remote config is now always enabled. This option is a no-op and will be removed in a future version.", level = DeprecationLevel.WARNING) Boolean remoteConfig)`	Preload PostHog remote config automatically Defaults to true
`final Integer`	`getFlushAt()`	Number of minimum events before they are sent over the wire Defaults to 20
`final Unit`	`setFlushAt(Integer flushAt)`	Number of minimum events before they are sent over the wire Defaults to 20
`final Integer`	`getMaxQueueSize()`	Number of maximum events in memory and disk, when the maximum is exceed, the oldest event is deleted and the new one takes place Defaults to 1000
`final Unit`	`setMaxQueueSize(Integer maxQueueSize)`	Number of maximum events in memory and disk, when the maximum is exceed, the oldest event is deleted and the new one takes place Defaults to 1000
`final Integer`	`getMaxBatchSize()`	Number of maximum events in a batch call Defaults to 50
`final Unit`	`setMaxBatchSize(Integer maxBatchSize)`	Number of maximum events in a batch call Defaults to 50
`final Integer`	`getFlushIntervalSeconds()`	Interval in seconds for sending events over the wire The lower the number, most likely more battery is used Defaults to 30s
`final Unit`	`setFlushIntervalSeconds(Integer flushIntervalSeconds)`	Interval in seconds for sending events over the wire The lower the number, most likely more battery is used Defaults to 30s
`final PostHogEncryption`	`getEncryption()`	Hook for encrypt and decrypt events Devices are sandbox so likely not needed Defaults to no encryption
`final Unit`	`setEncryption(PostHogEncryption encryption)`	Hook for encrypt and decrypt events Devices are sandbox so likely not needed Defaults to no encryption
`final PostHogOnFeatureFlags`	`getOnFeatureFlags()`	Hook that is called when feature flag definitions are loaded.
`final Unit`	`setOnFeatureFlags(PostHogOnFeatureFlags onFeatureFlags)`	Hook that is called when feature flag definitions are loaded.
`final Proxy`	`getProxy()`	Hook that allows to sanitize the event properties The hook is called before the event is cached or sent over the wire
`final Unit`	`setProxy(Proxy proxy)`	Hook that allows to sanitize the event properties The hook is called before the event is cached or sent over the wire
`final Integer`	`getFeatureFlagCacheSize()`	The maximum size of the feature flag cache in memory Defaults to 1000
`final Unit`	`setFeatureFlagCacheSize(Integer featureFlagCacheSize)`	The maximum size of the feature flag cache in memory Defaults to 1000
`final Integer`	`getFeatureFlagCacheMaxAgeMs()`	The maximum age of a feature flag cache record in memory in milliseconds Defaults to 5 minutes
`final Unit`	`setFeatureFlagCacheMaxAgeMs(Integer featureFlagCacheMaxAgeMs)`	The maximum age of a feature flag cache record in memory in milliseconds Defaults to 5 minutes
`final Integer`	`getFeatureFlagCalledCacheSize()`	The maximum size of the feature flag called cache in memory.
`final Unit`	`setFeatureFlagCalledCacheSize(Integer featureFlagCalledCacheSize)`	The maximum size of the feature flag called cache in memory.
`final Boolean`	`getLocalEvaluation()`	Enable local evaluation of feature flags When enabled, the SDK periodically fetches flag definitions and evaluates flags locally without making API calls for each flag check.
`final Unit`	`setLocalEvaluation(Boolean localEvaluation)`	Enable local evaluation of feature flags When enabled, the SDK periodically fetches flag definitions and evaluates flags locally without making API calls for each flag check.
`final String`	`getPersonalApiKey()`	Personal API key for local evaluation Required when localEvaluation is true.
`final Unit`	`setPersonalApiKey(String personalApiKey)`	Personal API key for local evaluation Required when localEvaluation is true.
`final Integer`	`getPollIntervalSeconds()`	Interval in seconds for polling feature flag definitions for local evaluation Defaults to 30 seconds
`final Unit`	`setPollIntervalSeconds(Integer pollIntervalSeconds)`	Interval in seconds for polling feature flag definitions for local evaluation Defaults to 30 seconds
`final List<String>`	`getEvaluationContexts()`	Evaluation contexts for feature flags List of contexts (e.g., "web", "mobile", "checkout") used to filter feature flag evaluations on the server side.
`final Unit`	`setEvaluationContexts(List<String> evaluationContexts)`	Evaluation contexts for feature flags List of contexts (e.g., "web", "mobile", "checkout") used to filter feature flag evaluations on the server side.
`final Unit`	`addBeforeSend(PostHogBeforeSend beforeSend)`
`final Unit`	`removeBeforeSend(PostHogBeforeSend beforeSend)`
`final Unit`	`addIntegration(PostHogIntegration integration)`
`final static PostHogConfig.Builder`	`builder(String apiKey)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PostHogConfig
```
PostHogConfig(String apiKey, String host, Boolean debug, Boolean sendFeatureFlagEvent, Boolean preloadFeatureFlags, Boolean remoteConfig, Integer flushAt, Integer maxQueueSize, Integer maxBatchSize, Integer flushIntervalSeconds, PostHogEncryption encryption, PostHogOnFeatureFlags onFeatureFlags, Proxy proxy, Integer featureFlagCacheSize, Integer featureFlagCacheMaxAgeMs, Integer featureFlagCalledCacheSize, Boolean localEvaluation, String personalApiKey, Integer pollIntervalSeconds, List<String> evaluationContexts)
```
- Method Detail
  - getApiKey
```
 final String getApiKey()
```
    The PostHog API Key
  - getHost
```
 final String getHost()
```
    The PostHog Host Defaults to https://us.i.posthog.com EU Host: https://eu.i.posthog.com
  - getDebug
```
 final Boolean getDebug()
```
    Logs the debug logs to the logger if enabled Defaults to false
  - setDebug
```
 final Unit setDebug(Boolean debug)
```
    Logs the debug logs to the logger if enabled Defaults to false
  - getSendFeatureFlagEvent
```
 final Boolean getSendFeatureFlagEvent()
```
    Send a $feature_flag_called event when a feature flag is used automatically Used by experiments
    Defaults to true
  - setSendFeatureFlagEvent
```
 final Unit setSendFeatureFlagEvent(Boolean sendFeatureFlagEvent)
```
    Send a $feature_flag_called event when a feature flag is used automatically Used by experiments
    Defaults to true
  - getPreloadFeatureFlags
```
 final Boolean getPreloadFeatureFlags()
```
    Preload feature flags automatically Docs https://posthog.com/docs/feature-flags and https://posthog.com/docs/experiments Defaults to true
  - setPreloadFeatureFlags
```
 final Unit setPreloadFeatureFlags(Boolean preloadFeatureFlags)
```
    Preload feature flags automatically Docs https://posthog.com/docs/feature-flags and https://posthog.com/docs/experiments Defaults to true
  - getRemoteConfig
```
 final Boolean getRemoteConfig()
```
    Preload PostHog remote config automatically Defaults to true
  - setRemoteConfig
```
 final Unit setRemoteConfig(@Deprecated(message = "Remote config is now always enabled. This option is a no-op and will be removed in a future version.", level = DeprecationLevel.WARNING) Boolean remoteConfig)
```
    Preload PostHog remote config automatically Defaults to true
  - getFlushAt
```
 final Integer getFlushAt()
```
    Number of minimum events before they are sent over the wire Defaults to 20
  - setFlushAt
```
 final Unit setFlushAt(Integer flushAt)
```
    Number of minimum events before they are sent over the wire Defaults to 20
  - getMaxQueueSize
```
 final Integer getMaxQueueSize()
```
    Number of maximum events in memory and disk, when the maximum is exceed, the oldest event is deleted and the new one takes place Defaults to 1000
  - setMaxQueueSize
```
 final Unit setMaxQueueSize(Integer maxQueueSize)
```
    Number of maximum events in memory and disk, when the maximum is exceed, the oldest event is deleted and the new one takes place Defaults to 1000
  - getMaxBatchSize
```
 final Integer getMaxBatchSize()
```
    Number of maximum events in a batch call Defaults to 50
  - setMaxBatchSize
```
 final Unit setMaxBatchSize(Integer maxBatchSize)
```
    Number of maximum events in a batch call Defaults to 50
  - getFlushIntervalSeconds
```
 final Integer getFlushIntervalSeconds()
```
    Interval in seconds for sending events over the wire The lower the number, most likely more battery is used Defaults to 30s
  - setFlushIntervalSeconds
```
 final Unit setFlushIntervalSeconds(Integer flushIntervalSeconds)
```
    Interval in seconds for sending events over the wire The lower the number, most likely more battery is used Defaults to 30s
  - getEncryption
```
 final PostHogEncryption getEncryption()
```
    Hook for encrypt and decrypt events Devices are sandbox so likely not needed Defaults to no encryption
  - setEncryption
```
 final Unit setEncryption(PostHogEncryption encryption)
```
    Hook for encrypt and decrypt events Devices are sandbox so likely not needed Defaults to no encryption
  - getOnFeatureFlags
```
 final PostHogOnFeatureFlags getOnFeatureFlags()
```
    Hook that is called when feature flag definitions are loaded. This is called immediately if local evaluation is not enabled. Defaults to no callback
  - setOnFeatureFlags
```
 final Unit setOnFeatureFlags(PostHogOnFeatureFlags onFeatureFlags)
```
    Hook that is called when feature flag definitions are loaded. This is called immediately if local evaluation is not enabled. Defaults to no callback
  - getProxy
```
 final Proxy getProxy()
```
    Hook that allows to sanitize the event properties The hook is called before the event is cached or sent over the wire
  - setProxy
```
 final Unit setProxy(Proxy proxy)
```
    Hook that allows to sanitize the event properties The hook is called before the event is cached or sent over the wire
  - getFeatureFlagCacheSize
```
 final Integer getFeatureFlagCacheSize()
```
    The maximum size of the feature flag cache in memory Defaults to 1000
  - setFeatureFlagCacheSize
```
 final Unit setFeatureFlagCacheSize(Integer featureFlagCacheSize)
```
    The maximum size of the feature flag cache in memory Defaults to 1000
  - getFeatureFlagCacheMaxAgeMs
```
 final Integer getFeatureFlagCacheMaxAgeMs()
```
    The maximum age of a feature flag cache record in memory in milliseconds Defaults to 5 minutes
  - setFeatureFlagCacheMaxAgeMs
```
 final Unit setFeatureFlagCacheMaxAgeMs(Integer featureFlagCacheMaxAgeMs)
```
    The maximum age of a feature flag cache record in memory in milliseconds Defaults to 5 minutes
  - getFeatureFlagCalledCacheSize
```
 final Integer getFeatureFlagCalledCacheSize()
```
    The maximum size of the feature flag called cache in memory. This cache prevents duplicate $feature_flag_called events from being sent by keeping track of per-user feature flag usage. Defaults to 1000
  - setFeatureFlagCalledCacheSize
```
 final Unit setFeatureFlagCalledCacheSize(Integer featureFlagCalledCacheSize)
```
    The maximum size of the feature flag called cache in memory. This cache prevents duplicate $feature_flag_called events from being sent by keeping track of per-user feature flag usage. Defaults to 1000
  - getLocalEvaluation
```
 final Boolean getLocalEvaluation()
```
    Enable local evaluation of feature flags When enabled, the SDK periodically fetches flag definitions and evaluates flags locally without making API calls for each flag check. Falls back to API if evaluation is inconclusive. Requires personalApiKey to be set. Defaults to false
  - setLocalEvaluation
```
 final Unit setLocalEvaluation(Boolean localEvaluation)
```
    Enable local evaluation of feature flags When enabled, the SDK periodically fetches flag definitions and evaluates flags locally without making API calls for each flag check. Falls back to API if evaluation is inconclusive. Requires personalApiKey to be set. Defaults to false
  - getPersonalApiKey
```
 final String getPersonalApiKey()
```
    Personal API key for local evaluation Required when localEvaluation is true. Defaults to null
  - setPersonalApiKey
```
 final Unit setPersonalApiKey(String personalApiKey)
```
    Personal API key for local evaluation Required when localEvaluation is true. Defaults to null
  - getPollIntervalSeconds
```
 final Integer getPollIntervalSeconds()
```
    Interval in seconds for polling feature flag definitions for local evaluation Defaults to 30 seconds
  - setPollIntervalSeconds
```
 final Unit setPollIntervalSeconds(Integer pollIntervalSeconds)
```
    Interval in seconds for polling feature flag definitions for local evaluation Defaults to 30 seconds
  - getEvaluationContexts
```
 final List<String> getEvaluationContexts()
```
    Evaluation contexts for feature flags List of contexts (e.g., "web", "mobile", "checkout") used to filter feature flag evaluations on the server side. Defaults to null
  - setEvaluationContexts
```
 final Unit setEvaluationContexts(List<String> evaluationContexts)
```
    Evaluation contexts for feature flags List of contexts (e.g., "web", "mobile", "checkout") used to filter feature flag evaluations on the server side. Defaults to null
  - addBeforeSend
```
 final Unit addBeforeSend(PostHogBeforeSend beforeSend)
```
  - removeBeforeSend
```
 final Unit removeBeforeSend(PostHogBeforeSend beforeSend)
```
  - addIntegration
```
 final Unit addIntegration(PostHogIntegration integration)
```
  - builder
```
 final static PostHogConfig.Builder builder(String apiKey)
```

Class PostHogConfig

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PostHogConfig

Method Detail

getApiKey

getHost

getDebug

setDebug

getSendFeatureFlagEvent

setSendFeatureFlagEvent

getPreloadFeatureFlags

setPreloadFeatureFlags

getRemoteConfig

setRemoteConfig

getFlushAt

setFlushAt

getMaxQueueSize

setMaxQueueSize

getMaxBatchSize

setMaxBatchSize

getFlushIntervalSeconds

setFlushIntervalSeconds

getEncryption

setEncryption

getOnFeatureFlags

setOnFeatureFlags

getProxy

setProxy

getFeatureFlagCacheSize

setFeatureFlagCacheSize

getFeatureFlagCacheMaxAgeMs

setFeatureFlagCacheMaxAgeMs

getFeatureFlagCalledCacheSize

setFeatureFlagCalledCacheSize

getLocalEvaluation

setLocalEvaluation

getPersonalApiKey

setPersonalApiKey

getPollIntervalSeconds

setPollIntervalSeconds

getEvaluationContexts

setEvaluationContexts

addBeforeSend

removeBeforeSend

addIntegration

builder