LDClient (launchdarkly-android-client-sdk 2.8.5 API)

java.lang.Object
- com.launchdarkly.android.LDClient

All Implemented Interfaces:

LDClientInterface, java.io.Closeable, java.lang.AutoCloseable
```
public class LDClient
extends java.lang.Object
implements LDClientInterface, java.io.Closeable
```
Client for accessing LaunchDarkly's Feature Flag system. This class enforces a singleton pattern. The main entry point is the init(Application, LDConfig, LDUser) method.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LDClient(android.app.Application application, LDConfig config)`
`protected`	`LDClient(android.app.Application application, LDConfig config, java.lang.String environmentName)`

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`void`	`close()` Closes the client.
`java.lang.Float`	`floatVariation(java.lang.String flagKey, java.lang.Float fallback)` Returns the flag value for the current user.
`EvaluationDetail<java.lang.Float>`	`floatVariationDetail(java.lang.String flagKey, java.lang.Float fallback)` Returns the flag value for the current user, along with information about how it was calculated.
`void`	`flush()` Sends all pending events to LaunchDarkly.
`static LDClient`	`get()`
`ConnectionInformation`	`getConnectionInformation()` Gets a `ConnectionInformation` object from the client representing the current state of the clients connection.
`static LDClient`	`getForMobileKey(java.lang.String keyName)`
`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.
`static java.util.concurrent.Future<LDClient>`	`init(android.app.Application application, LDConfig config, LDUser user)` Initializes the singleton/primary instance.
`static LDClient`	`init(android.app.Application application, LDConfig config, LDUser user, int startWaitSeconds)` Initializes the singleton instance and blocks for up to `startWaitSeconds` seconds until the client has been initialized.
`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)`
`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`	`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)`

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

- Constructor Detail
  - LDClient
```
protected LDClient(android.app.Application application,
                   LDConfig config)
```
  - LDClient
```
protected LDClient(android.app.Application application,
                   LDConfig config,
                   java.lang.String environmentName)
```
- Method Detail
  - init
```
public static java.util.concurrent.Future<LDClient> init(android.app.Application application,
                                                         LDConfig config,
                                                         LDUser user)
```
    Initializes the singleton/primary instance. The result is a Future which will complete once the client has been initialized with the latest feature flag values. For immediate access to the Client (possibly with out of date feature flags), it is safe to ignore the return value of this method, and afterward call get()
    If the client has already been initialized, is configured for offline mode, or the device is not connected to the internet, this method will return a Future that is already in the completed state.
    
    Parameters:
    
    application - Your Android application.
    
    config - Configuration used to set up the client
    
    user - The user used in evaluating feature flags
    
    Returns:
    
    a Future which will complete once the client has been initialized.
  - init
```
public static LDClient init(android.app.Application application,
                            LDConfig config,
                            LDUser user,
                            int startWaitSeconds)
```
    Initializes the singleton instance and blocks for up to startWaitSeconds seconds until the client has been initialized. If the client does not initialize within startWaitSeconds seconds, it is returned anyway and can be used, but may not have fetched the most recent feature flag values.
    
    Parameters:
    
    application - Your Android application.
    
    config - Configuration used to set up the client
    
    user - The user used in evaluating feature flags
    
    startWaitSeconds - Maximum number of seconds to wait for the client to initialize
    
    Returns:
    
    The primary LDClient instance
  - get
```
public static LDClient get()
                    throws LaunchDarklyException
```
    Returns:
    
    the singleton instance.
    
    Throws:
    
    LaunchDarklyException - if init(Application, LDConfig, LDUser) has not been called.
  - getForMobileKey
```
public static LDClient getForMobileKey(java.lang.String keyName)
                                throws LaunchDarklyException
```
    Parameters:
    
    keyName - The name to lookup the instance by.
    
    Returns:
    
    the singleton instance for the environment associated with the given name.
    
    Throws:
    
    LaunchDarklyException - if init(Application, LDConfig, LDUser) has not been called.
  - track
```
public void track(java.lang.String eventName,
                  com.google.gson.JsonElement data)
```
    Description copied from interface: LDClientInterface
    
    Tracks that a user performed an event.
    
    Specified by:
    
    track in interface LDClientInterface
    
    Parameters:
    
    eventName - the name of the event
    
    data - a JSON object containing additional data associated with the event
  - track
```
public void track(java.lang.String eventName)
```
    Description copied from interface: LDClientInterface
    
    Tracks that a user performed an event.
    
    Specified by:
    
    track in interface LDClientInterface
    
    Parameters:
    
    eventName - the name of the event
  - identify
```
public java.util.concurrent.Future<java.lang.Void> identify(LDUser user)
```
    Description copied from interface: LDClientInterface
    
    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.
    
    Specified by:
    
    identify in interface LDClientInterface
    
    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.
  - allFlags
```
public java.util.Map<java.lang.String,?> allFlags()
```
    Description copied from interface: LDClientInterface
    
    Returns a map of all feature flags for the current user. No events are sent to LaunchDarkly.
    
    Specified by:
    
    allFlags in interface LDClientInterface
    
    Returns:
    
    a map of all feature flags
  - boolVariation
```
public java.lang.Boolean boolVariation(java.lang.String flagKey,
                                       java.lang.Boolean fallback)
```
    Description copied from interface: LDClientInterface
    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
    Specified by:
    
    boolVariation in interface LDClientInterface
    
    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
```
public EvaluationDetail<java.lang.Boolean> boolVariationDetail(java.lang.String flagKey,
                                                               java.lang.Boolean fallback)
```
    Description copied from interface: LDClientInterface
    
    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 in LDConfig.Builder.evaluationReasons. Otherwise, the reason property of the result will be null.
    
    Specified by:
    
    boolVariationDetail in interface LDClientInterface
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see LDClientInterface.boolVariation(String, Boolean))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - intVariation
```
public java.lang.Integer intVariation(java.lang.String flagKey,
                                      java.lang.Integer fallback)
```
    Description copied from interface: LDClientInterface
    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
    Specified by:
    
    intVariation in interface LDClientInterface
    
    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
```
public EvaluationDetail<java.lang.Integer> intVariationDetail(java.lang.String flagKey,
                                                              java.lang.Integer fallback)
```
    Description copied from interface: LDClientInterface
    
    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 in LDConfig.Builder.evaluationReasons. Otherwise, the reason property of the result will be null.
    
    Specified by:
    
    intVariationDetail in interface LDClientInterface
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see LDClientInterface.intVariation(String, Integer))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - floatVariation
```
public java.lang.Float floatVariation(java.lang.String flagKey,
                                      java.lang.Float fallback)
```
    Description copied from interface: LDClientInterface
    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
    Specified by:
    
    floatVariation in interface LDClientInterface
    
    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
```
public EvaluationDetail<java.lang.Float> floatVariationDetail(java.lang.String flagKey,
                                                              java.lang.Float fallback)
```
    Description copied from interface: LDClientInterface
    
    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 in LDConfig.Builder.evaluationReasons. Otherwise, the reason property of the result will be null.
    
    Specified by:
    
    floatVariationDetail in interface LDClientInterface
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see LDClientInterface.floatVariation(String, Float))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - stringVariation
```
public java.lang.String stringVariation(java.lang.String flagKey,
                                        java.lang.String fallback)
```
    Description copied from interface: LDClientInterface
    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
    Specified by:
    
    stringVariation in interface LDClientInterface
    
    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
```
public EvaluationDetail<java.lang.String> stringVariationDetail(java.lang.String flagKey,
                                                                java.lang.String fallback)
```
    Description copied from interface: LDClientInterface
    
    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 in LDConfig.Builder.evaluationReasons. Otherwise, the reason property of the result will be null.
    
    Specified by:
    
    stringVariationDetail in interface LDClientInterface
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see LDClientInterface.stringVariation(String, String))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - jsonVariation
```
public com.google.gson.JsonElement jsonVariation(java.lang.String flagKey,
                                                 com.google.gson.JsonElement fallback)
```
    Description copied from interface: LDClientInterface
    Returns the flag value for the current user. Returns fallback when one of the following occurs:
    1. Flag is missing
    2. Any other error
    Specified by:
    
    jsonVariation in interface LDClientInterface
    
    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
```
public EvaluationDetail<com.google.gson.JsonElement> jsonVariationDetail(java.lang.String flagKey,
                                                                         com.google.gson.JsonElement fallback)
```
    Description copied from interface: LDClientInterface
    
    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 in LDConfig.Builder.evaluationReasons. Otherwise, the reason property of the result will be null.
    
    Specified by:
    
    jsonVariationDetail in interface LDClientInterface
    
    Parameters:
    
    flagKey - key for the flag to evaluate
    
    fallback - fallback value in case of errors evaluating the flag (see LDClientInterface.jsonVariation(String, JsonElement))
    
    Returns:
    
    an EvaluationDetail object containing the value and other information.
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the client. This should only be called at the end of a client's lifecycle.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
```
    Description copied from interface: LDClientInterface
    
    Sends all pending events to LaunchDarkly.
    
    Specified by:
    
    flush in interface LDClientInterface
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: LDClientInterface
    
    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).
    
    Specified by:
    
    isInitialized in interface LDClientInterface
    
    Returns:
    
    true if the client is initialized or offline
  - isOffline
```
public boolean isOffline()
```
    Description copied from interface: LDClientInterface
    
    Checks whether the client has been put into offline mode. This is true only if LDClientInterface.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.
    
    Specified by:
    
    isOffline in interface LDClientInterface
    
    Returns:
    
    true if the client is in offline mode
  - setOffline
```
public void setOffline()
```
    Description copied from interface: LDClientInterface
    
    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.
    
    Specified by:
    
    setOffline in interface LDClientInterface
  - setOnline
```
public void setOnline()
```
    Description copied from interface: LDClientInterface
    
    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.
    
    Specified by:
    
    setOnline in interface LDClientInterface
  - registerFeatureFlagListener
```
public void registerFeatureFlagListener(java.lang.String flagKey,
                                        FeatureFlagChangeListener listener)
```
    Description copied from interface: LDClientInterface
    
    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.
    
    Specified by:
    
    registerFeatureFlagListener in interface LDClientInterface
    
    Parameters:
    
    flagKey - the flag key to attach the listener to
    
    listener - the listener to attach to the flag key
    
    See Also:
    
    LDClientInterface.unregisterFeatureFlagListener(String, FeatureFlagChangeListener)
  - unregisterFeatureFlagListener
```
public void unregisterFeatureFlagListener(java.lang.String flagKey,
                                          FeatureFlagChangeListener listener)
```
    Description copied from interface: LDClientInterface
    
    Unregisters a FeatureFlagChangeListener for the flagKey.
    
    Specified by:
    
    unregisterFeatureFlagListener in interface LDClientInterface
    
    Parameters:
    
    flagKey - the flag key to remove the listener from
    
    listener - the listener to remove from the flag key
    
    See Also:
    
    LDClientInterface.registerFeatureFlagListener(String, FeatureFlagChangeListener)
  - isDisableBackgroundPolling
```
public boolean isDisableBackgroundPolling()
```
    Description copied from interface: LDClientInterface
    
    Checks whether LDConfig.Builder.setDisableBackgroundUpdating(boolean) was set to true in the configuration.
    
    Specified by:
    
    isDisableBackgroundPolling in interface LDClientInterface
    
    Returns:
    
    true if background polling is disabled
  - getConnectionInformation
```
public ConnectionInformation getConnectionInformation()
```
    Description copied from interface: LDClientInterface
    
    Gets a ConnectionInformation object from the client representing the current state of the clients connection.
    
    Specified by:
    
    getConnectionInformation in interface LDClientInterface
    
    Returns:
    
    An object representing the status of the connection to LaunchDarkly.
  - registerStatusListener
```
public void registerStatusListener(LDStatusListener LDStatusListener)
```
    Specified by:
    
    registerStatusListener in interface LDClientInterface
  - unregisterStatusListener
```
public void unregisterStatusListener(LDStatusListener LDStatusListener)
```
    Specified by:
    
    unregisterStatusListener in interface LDClientInterface
  - registerAllFlagsListener
```
public void registerAllFlagsListener(LDAllFlagsListener allFlagsListener)
```
    Description copied from interface: LDClientInterface
    
    Registers a LDAllFlagsListener to be called when a flag update is processed by the SDK.
    
    Specified by:
    
    registerAllFlagsListener in interface LDClientInterface
    
    Parameters:
    
    allFlagsListener - the listener to be called on a flag update
  - unregisterAllFlagsListener
```
public void unregisterAllFlagsListener(LDAllFlagsListener allFlagsListener)
```
    Description copied from interface: LDClientInterface
    
    Unregisters a LDAllFlagsListener so it will no longer be called on flag updates.
    
    Specified by:
    
    unregisterAllFlagsListener in interface LDClientInterface
    
    Parameters:
    
    allFlagsListener - the listener to be removed
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: LDClientInterface
    
    Returns the version of the SDK, for instance "2.7.0".
    
    Specified by:
    
    getVersion in interface LDClientInterface
    
    Returns:
    
    the version string

Class LDClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LDClient

LDClient

Method Detail

init

init

get

getForMobileKey

track

track

identify

allFlags

boolVariation

boolVariationDetail

intVariation

intVariationDetail

floatVariation

floatVariationDetail

stringVariation

stringVariationDetail

jsonVariation

jsonVariationDetail

close

flush

isInitialized

isOffline

setOffline

setOnline

registerFeatureFlagListener

unregisterFeatureFlagListener

isDisableBackgroundPolling

getConnectionInformation

registerStatusListener

unregisterStatusListener

registerAllFlagsListener

unregisterAllFlagsListener

getVersion