LDClientInterface (launchdarkly-android-client-sdk 2.14.2 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

LDClient
```
public interface LDClientInterface
extends java.io.Closeable
```
The interface for the LaunchDarkly SDK client.
To obtain a client instance, use LDClient methods such as LDClient.init(Application, LDConfig, LDUser).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,?>`	`allFlags()` Returns a map of all feature flags for the current user.
`java.lang.Boolean`	`boolVariation(java.lang.String flagKey, java.lang.Boolean fallback)` Returns the flag value for the current user.
`EvaluationDetail<java.lang.Boolean>`	`boolVariationDetail(java.lang.String flagKey, java.lang.Boolean fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`double`	`doubleVariation(java.lang.String flagKey, double fallback)` Returns the flag value for the current user.
`EvaluationDetail<java.lang.Double>`	`doubleVariationDetail(java.lang.String flagKey, double fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`java.lang.Float`	`floatVariation(java.lang.String flagKey, java.lang.Float fallback)` Deprecated. Please use `doubleVariation(String, double)` instead.
`EvaluationDetail<java.lang.Float>`	`floatVariationDetail(java.lang.String flagKey, java.lang.Float fallback)` Deprecated. Please use `doubleVariationDetail(String, double)` instead.
`void`	`flush()` Sends all pending events to LaunchDarkly.
`ConnectionInformation`	`getConnectionInformation()` Gets a `ConnectionInformation` object from the client representing the current state of the clients connection.
`java.lang.String`	`getVersion()` Returns the version of the SDK, for instance "2.7.0".
`java.util.concurrent.Future<java.lang.Void>`	`identify(LDUser user)` Sets the current user, retrieves flags for that user, then sends an Identify Event to LaunchDarkly.
`java.lang.Integer`	`intVariation(java.lang.String flagKey, java.lang.Integer fallback)` Returns the flag value for the current user.
`EvaluationDetail<java.lang.Integer>`	`intVariationDetail(java.lang.String flagKey, java.lang.Integer fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`boolean`	`isDisableBackgroundPolling()` Checks whether `LDConfig.Builder.setDisableBackgroundUpdating(boolean)` was set to `true` in the configuration.
`boolean`	`isInitialized()` Checks whether the client is ready to return feature flag values.
`boolean`	`isOffline()` Checks whether the client has been put into offline mode.
`com.google.gson.JsonElement`	`jsonVariation(java.lang.String flagKey, com.google.gson.JsonElement fallback)` Returns the flag value for the current user.
`EvaluationDetail<com.google.gson.JsonElement>`	`jsonVariationDetail(java.lang.String flagKey, com.google.gson.JsonElement fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`void`	`registerAllFlagsListener(LDAllFlagsListener allFlagsListener)` Registers a `LDAllFlagsListener` to be called when a flag update is processed by the SDK.
`void`	`registerFeatureFlagListener(java.lang.String flagKey, FeatureFlagChangeListener listener)` Registers a `FeatureFlagChangeListener` to be called when the `flagKey` changes from its current value.
`void`	`registerStatusListener(LDStatusListener LDStatusListener)` Registers a `LDStatusListener` to be called on connection status updates.
`void`	`setOffline()` Shuts down any network connections maintained by the client and puts the client in offline mode, preventing the client from opening new network connections until `setOnline()` is called.
`void`	`setOnline()` Restores network connectivity for the client, if the client was previously in offline mode.
`java.lang.String`	`stringVariation(java.lang.String flagKey, java.lang.String fallback)` Returns the flag value for the current user.
`EvaluationDetail<java.lang.String>`	`stringVariationDetail(java.lang.String flagKey, java.lang.String fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`void`	`track(java.lang.String eventName)` Tracks that a user performed an event.
`void`	`track(java.lang.String eventName, com.google.gson.JsonElement data)` Tracks that a user performed an event.
`void`	`track(java.lang.String eventName, com.google.gson.JsonElement data, java.lang.Double metricValue)` Tracks that a user performed an event.
`void`	`unregisterAllFlagsListener(LDAllFlagsListener allFlagsListener)` Unregisters a `LDAllFlagsListener` so it will no longer be called on flag updates.
`void`	`unregisterFeatureFlagListener(java.lang.String flagKey, FeatureFlagChangeListener listener)` Unregisters a `FeatureFlagChangeListener` for the `flagKey`.
`void`	`unregisterStatusListener(LDStatusListener LDStatusListener)` Unregisters a `LDStatusListener` so it will no longer be called on connection status updates.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - isInitialized
```
boolean isInitialized()
```
    Checks whether the client is ready to return feature flag values. This is true if either the client has successfully connected to LaunchDarkly and received feature flags, or the client has been put into offline mode (in which case it will return only default flag values).
    
    Returns:
    
    true if the client is initialized or offline
  - isOffline
```
boolean isOffline()
```
    Checks whether the client has been put into offline mode. This is true only if setOffline() was called, or if the configuration had LDConfig.Builder.setOffline(boolean) set to true, not if the client is simply offline due to a loss of network connectivity.
    
    Returns:
    
    true if the client is in offline mode
  - setOffline
```
void setOffline()
```
    Shuts down any network connections maintained by the client and puts the client in offline mode, preventing the client from opening new network connections until setOnline() is called.
    Note: The client automatically monitors the device's network connectivity and app foreground status, so calling setOffline() or setOnline() is normally unnecessary in most situations.
  - setOnline
```
void setOnline()
```
    Restores network connectivity for the client, if the client was previously in offline mode. This operation may be throttled if it is called too frequently.
    Note: The client automatically monitors the device's network connectivity and app foreground status, so calling setOffline() or setOnline() is normally unnecessary in most situations.
  - track
```
void track(java.lang.String eventName,
           com.google.gson.JsonElement data,
           java.lang.Double metricValue)
```
    Tracks that a user performed an event.
    
    Parameters:
    
    eventName - the name of the event
    
    data - a JSON object containing additional data associated with the event
    
    metricValue - A numeric value used by the LaunchDarkly experimentation feature in numeric custom metrics. Can be omitted if this event is used by only non-numeric metrics. This field will also be returned as part of the custom event for Data Export.
  - track
```
void track(java.lang.String eventName,
           com.google.gson.JsonElement data)
```
    Tracks that a user performed an event.
    
    Parameters:
    
    eventName - the name of the event
    
    data - a JSON object containing additional data associated with the event
  - track
```
void track(java.lang.String eventName)
```
    Tracks that a user performed an event.
    
    Parameters:
    
    eventName - the name of the event
  - identify
```
java.util.concurrent.Future<java.lang.Void> identify(LDUser user)
```
    Sets the current user, retrieves flags for that user, then sends an Identify Event to LaunchDarkly. The 5 most recent users' flag settings are kept locally.
    
    Parameters:
    
    user - The user for evaluation and event reporting
    
    Returns:
    
    Future whose success indicates this user's flag settings have been stored locally and are ready for evaluation.
  - flush
```
void flush()
```
    Sends all pending events to LaunchDarkly.
  - allFlags
```
java.util.Map<java.lang.String,?> allFlags()
```
    Returns a map of all feature flags for the current user. No events are sent to LaunchDarkly.
    
    Returns:
    
    a map of all feature flags
  - boolVariation
```
java.lang.Boolean boolVariation(java.lang.String flagKey,
                                java.lang.Boolean fallback)
```
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. The flag is not of a boolean type
    3. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - boolVariationDetail
```
EvaluationDetail<java.lang.Boolean> boolVariationDetail(java.lang.String flagKey,
                                                        java.lang.Boolean fallback)
```
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see boolVariation(String, Boolean))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
    
    Since:
    
    2.7.0
  - intVariation
```
java.lang.Integer intVariation(java.lang.String flagKey,
                               java.lang.Integer fallback)
```
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. The flag is not of a numeric type
    3. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - intVariationDetail
```
EvaluationDetail<java.lang.Integer> intVariationDetail(java.lang.String flagKey,
                                                       java.lang.Integer fallback)
```
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see intVariation(String, Integer))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
    
    Since:
    
    2.7.0
  - floatVariation
```
@Deprecated
java.lang.Float floatVariation(java.lang.String flagKey,
                                           java.lang.Float fallback)
```
    Deprecated. Please use doubleVariation(String, double) instead.
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. The flag is not of a numeric type
    3. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - floatVariationDetail
```
@Deprecated
EvaluationDetail<java.lang.Float> floatVariationDetail(java.lang.String flagKey,
                                                                   java.lang.Float fallback)
```
    Deprecated. Please use doubleVariationDetail(String, double) instead.
    
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see floatVariation(String, Float))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
    
    Since:
    
    2.7.0
  - doubleVariation
```
double doubleVariation(java.lang.String flagKey,
                       double fallback)
```
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. The flag is not of a numeric type
    3. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - doubleVariationDetail
```
EvaluationDetail<java.lang.Double> doubleVariationDetail(java.lang.String flagKey,
                                                         double fallback)
```
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see doubleVariation(String, double))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - stringVariation
```
java.lang.String stringVariation(java.lang.String flagKey,
                                 java.lang.String fallback)
```
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. The flag is not of a string type
    3. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - stringVariationDetail
```
EvaluationDetail<java.lang.String> stringVariationDetail(java.lang.String flagKey,
                                                         java.lang.String fallback)
```
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see stringVariation(String, String))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
    
    Since:
    
    2.7.0
  - jsonVariation
```
com.google.gson.JsonElement jsonVariation(java.lang.String flagKey,
                                          com.google.gson.JsonElement fallback)
```
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. Any other error
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag
    
    Returns:
    
    value of the flag or fallback
  - jsonVariationDetail
```
EvaluationDetail<com.google.gson.JsonElement> jsonVariationDetail(java.lang.String flagKey,
                                                                  com.google.gson.JsonElement fallback)
```
    Returns the flag value for the current user, along with information about how it was calculated. Note that this will only work if you have set evaluationReasons to true with LDConfig.Builder.setEvaluationReasons(boolean). Otherwise, the reason property of the result will be null.
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see jsonVariation(String, JsonElement))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
    
    Since:
    
    2.7.0
  - registerFeatureFlagListener
```
void registerFeatureFlagListener(java.lang.String flagKey,
                                 FeatureFlagChangeListener listener)
```
    Registers a FeatureFlagChangeListener to be called when the flagKey changes from its current value. If the feature flag is deleted, the listener will be unregistered.
    
    Parameters:
    
    flagKey - the flag key to attach the listener to
    
    listener - the listener to attach to the flag key
    
    See Also:
    
    unregisterFeatureFlagListener(String, FeatureFlagChangeListener)
  - unregisterFeatureFlagListener
```
void unregisterFeatureFlagListener(java.lang.String flagKey,
                                   FeatureFlagChangeListener listener)
```
    Unregisters a FeatureFlagChangeListener for the flagKey.
    
    Parameters:
    
    flagKey - the flag key to remove the listener from
    
    listener - the listener to remove from the flag key
    
    See Also:
    
    registerFeatureFlagListener(String, FeatureFlagChangeListener)
  - getConnectionInformation
```
ConnectionInformation getConnectionInformation()
```
    Gets a ConnectionInformation object from the client representing the current state of the clients connection.
    
    Returns:
    
    An object representing the status of the connection to LaunchDarkly.
  - unregisterStatusListener
```
void unregisterStatusListener(LDStatusListener LDStatusListener)
```
    Unregisters a LDStatusListener so it will no longer be called on connection status updates.
    
    Parameters:
    
    LDStatusListener - the listener to be removed
  - registerStatusListener
```
void registerStatusListener(LDStatusListener LDStatusListener)
```
    Registers a LDStatusListener to be called on connection status updates.
    
    Parameters:
    
    LDStatusListener - the listener to be called on a connection status update
  - registerAllFlagsListener
```
void registerAllFlagsListener(LDAllFlagsListener allFlagsListener)
```
    Registers a LDAllFlagsListener to be called when a flag update is processed by the SDK.
    
    Parameters:
    
    allFlagsListener - the listener to be called on a flag update
  - unregisterAllFlagsListener
```
void unregisterAllFlagsListener(LDAllFlagsListener allFlagsListener)
```
    Unregisters a LDAllFlagsListener so it will no longer be called on flag updates.
    
    Parameters:
    
    allFlagsListener - the listener to be removed
  - isDisableBackgroundPolling
```
boolean isDisableBackgroundPolling()
```
    Checks whether LDConfig.Builder.setDisableBackgroundUpdating(boolean) was set to true in the configuration.
    
    Returns:
    
    true if background polling is disabled
  - getVersion
```
java.lang.String getVersion()
```
    Returns the version of the SDK, for instance "2.7.0".
    
    Returns:
    
    the version string
    
    Since:
    
    2.7.0

Interface LDClientInterface

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

isInitialized

isOffline

setOffline

setOnline

track

track

track

identify

flush

allFlags

boolVariation

boolVariationDetail

intVariation

intVariationDetail

floatVariation

floatVariationDetail

doubleVariation

doubleVariationDetail

stringVariation

stringVariationDetail

jsonVariation

jsonVariationDetail

registerFeatureFlagListener

unregisterFeatureFlagListener

getConnectionInformation

unregisterStatusListener

registerStatusListener

registerAllFlagsListener

unregisterAllFlagsListener

isDisableBackgroundPolling

getVersion