Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- adapter() - Static method in class com.launchdarkly.sdk.android.LDAndroidLogging
- adapter() - Static method in class com.launchdarkly.sdk.android.LDTimberLogging
- add(boolean) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(double) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(float) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(int) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(long) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(LDContext) - Method in class com.launchdarkly.sdk.ContextMultiBuilder
-
Adds an individual LDContext for a specific kind to the builer.
- add(LDValue) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- add(String) - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Adds a new element to the builder.
- allAttributesPrivate - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
All attributes should be treated as private
- allAttributesPrivate(boolean) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Sets whether or not all optional context attributes should be hidden from LaunchDarkly.
- allFlags() - Method in class com.launchdarkly.sdk.android.LDClient
- allFlags() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns a map of all feature flags for the current evaluation context.
- anonymous(boolean) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets whether the context is only intended for flag evaluations and should not be indexed by LaunchDarkly.
- anonymous(boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets whether this user is anonymous.
- ANONYMOUS - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the anonymous attribute.
- APPLICATION_ID - Static variable in class com.launchdarkly.sdk.android.test.BuildConfig
- applicationId(String) - Method in class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Sets a unique identifier representing the application where the LaunchDarkly SDK is running.
- applicationInfo() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration builder for the SDK's application metadata.
- applicationInfo(ApplicationInfoBuilder) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the SDK's application metadata, which may be used in LaunchDarkly analytics or other product features, but does not affect feature flag evaluations.
- ApplicationInfo - Class in com.launchdarkly.sdk.android.subsystems
-
Encapsulates the SDK's application metadata.
- ApplicationInfo(String, String, String, String) - Constructor for class com.launchdarkly.sdk.android.subsystems.ApplicationInfo
-
Used internally by the SDK to store application metadata.
- ApplicationInfoBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring the SDK's application metadata.
- ApplicationInfoBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Create an empty ApplicationInfoBuilder.
- applicationName(String) - Method in class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Sets a human friendly name for the application in which the LaunchDarkly SDK is running.
- applicationVersion(String) - Method in class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Sets a unique identifier representing the version of the application where the LaunchDarkly SDK is running.
- applicationVersionName(String) - Method in class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Sets a human friendly name for the version of the application in which the LaunchDarkly SDK is running.
- apply(LDContext) - Method in interface com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder.VariationFunc
-
Returns the result for the specified context, or null if undefined.
- ARRAY - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is an array.
- ArrayBuilder - Class in com.launchdarkly.sdk
-
A builder created by
LDValue.buildArray()
. - ArrayBuilder() - Constructor for class com.launchdarkly.sdk.ArrayBuilder
- arrayFrom(Iterable<T>) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an array, from a sequence of this type. - arrayOf(LDValue...) - Static method in class com.launchdarkly.sdk.LDValue
-
Creates an array value from the specified values.
- arrayOf(T...) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an array, from a sequence of this type. - AttributeRef - Class in com.launchdarkly.sdk
-
An attribute name or path expression identifying a value within an
LDContext
. - AutoEnvContextModifier - Class in com.launchdarkly.sdk.android
-
An
IContextModifier
that will add a few context kinds with environmental information that is useful out of the box. - AutoEnvContextModifier(PersistentDataStoreWrapper, IEnvironmentReporter, LDLogger) - Constructor for class com.launchdarkly.sdk.android.AutoEnvContextModifier
- autoPlantDebugTree(boolean) - Method in class com.launchdarkly.sdk.android.LDTimberLogging.Adapter
-
Returns a modified logging adapter with the automatic debug tree behavior changed.
- avatar(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's avatar.
- AVATAR - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the avatar URL attribute.
B
- BACKGROUND_DISABLED - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK was configured with background polling disabled.
- BACKGROUND_POLLING - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK has detected the application is in the background and has transitioned to battery-saving background polling.
- backgroundPollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
The background polling interval in millis
- backgroundPollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
Background polling interval in millis
- backgroundPollIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
Sets the interval between feature flag updates when the application is running in the background.
- backgroundPollIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
Sets the interval between feature flag updates when the application is running in the background.
- blockingFlush() - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Specifies that any buffered events should be sent immediately, blocking until done.
- Boolean - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for booleans. - BOOLEAN - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is a boolean.
- booleanFlag() - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
A shortcut for setting the flag to use the standard boolean configuration.
- booleanValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a boolean if it is explicitly a boolean.
- boolVariation(String, boolean) - Method in class com.launchdarkly.sdk.android.LDClient
- boolVariation(String, boolean) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the boolean value of a feature flag for the current evaluation context.
- boolVariationDetail(String, boolean) - Method in class com.launchdarkly.sdk.android.LDClient
- boolVariationDetail(String, boolean) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the boolean value of a feature flag for the current evaluation context, along with information about how it was calculated.
- build() - Method in class com.launchdarkly.sdk.android.env.EnvironmentReporterBuilder
- build() - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Returns the configured
LDConfig
object. - build() - Method in class com.launchdarkly.sdk.ArrayBuilder
-
Returns an array containing the builder's current elements.
- build() - Method in class com.launchdarkly.sdk.ContextBuilder
-
Creates an
LDContext
from the current builder properties. - build() - Method in class com.launchdarkly.sdk.ContextMultiBuilder
-
Creates an
LDContext
from the current builder properties. - build() - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Builds the configured
LDUser
object. - build() - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Returns an object containing the builder's current elements.
- build(ClientContext) - Method in class com.launchdarkly.sdk.android.integrations.TestData
- build(ClientContext) - Method in interface com.launchdarkly.sdk.android.subsystems.ComponentConfigurer
-
Called internally by the SDK to create an implementation instance.
- BUILD_TYPE - Static variable in class com.launchdarkly.sdk.android.BuildConfig
- BUILD_TYPE - Static variable in class com.launchdarkly.sdk.android.test.BuildConfig
- buildArray() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an array value.
- BuildConfig - Class in com.launchdarkly.sdk.android
- BuildConfig - Class in com.launchdarkly.sdk.android.test
- BuildConfig() - Constructor for class com.launchdarkly.sdk.android.BuildConfig
- BuildConfig() - Constructor for class com.launchdarkly.sdk.android.test.BuildConfig
- builder(ContextKind, String) - Static method in class com.launchdarkly.sdk.LDContext
- builder(String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a
ContextBuilder
for building an LDContext, initializing itskey
and settingkind
toContextKind.DEFAULT
. - Builder(LDConfig.Builder.AutoEnvAttributes) - Constructor for class com.launchdarkly.sdk.android.LDConfig.Builder
-
LDConfig.Builder constructor.
- Builder(LDUser) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Creates a builder based on an existing user.
- Builder(String) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Creates a builder with the specified key.
- builderFromContext(LDContext) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a builder whose properties are the same as an existing single-kind LDContext.
- buildObject() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an object value.
C
- Callback<T> - Interface in com.launchdarkly.sdk.android.subsystems
-
General-purpose interface for callbacks that can succeed or fail.
- capacity - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The capacity of the event buffer
- capacity(int) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Set the capacity of the events buffer.
- clear(String, boolean) - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Removes any values that currently exist in the given namespace.
- CLIENT_NOT_READY - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller tried to evaluate a flag before the client had successfully initialized.
- ClientContext - Class in com.launchdarkly.sdk.android.subsystems
-
Configuration information provided by the
LDClient
when creating components. - ClientContext(ClientContext) - Constructor for class com.launchdarkly.sdk.android.subsystems.ClientContext
- ClientContext(String, IEnvironmentReporter, LDLogger, LDConfig, DataSourceUpdateSink, String, boolean, LDContext, HttpConfiguration, boolean, Boolean, ServiceEndpoints, boolean) - Constructor for class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Constructs an instance, specifying all properties.
- close() - Method in class com.launchdarkly.sdk.android.LDClient
-
Closes the client.
- com.launchdarkly.sdk - package com.launchdarkly.sdk
-
Base namespace for LaunchDarkly Java-based SDKs, containing common types.
- com.launchdarkly.sdk.android - package com.launchdarkly.sdk.android
-
Main package for the LaunchDarkly Android SDK, containing the client and configuration classes.
- com.launchdarkly.sdk.android.env - package com.launchdarkly.sdk.android.env
- com.launchdarkly.sdk.android.integrations - package com.launchdarkly.sdk.android.integrations
-
This package contains integration tools for connecting the SDK to other software components, or configuring how it connects to LaunchDarkly.
- com.launchdarkly.sdk.android.interfaces - package com.launchdarkly.sdk.android.interfaces
-
Types that are part of the public API, but are not needed for basic use of the SDK.
- com.launchdarkly.sdk.android.subsystems - package com.launchdarkly.sdk.android.subsystems
-
Interfaces for implementation of LaunchDarkly SDK components.
- com.launchdarkly.sdk.android.test - package com.launchdarkly.sdk.android.test
- com.launchdarkly.sdk.json - package com.launchdarkly.sdk.json
-
Helper classes and methods for interoperability with JSON.
- compareTo(AttributeRef) - Method in class com.launchdarkly.sdk.AttributeRef
- compareTo(ContextKind) - Method in class com.launchdarkly.sdk.ContextKind
- ComponentConfigurer<T> - Interface in com.launchdarkly.sdk.android.subsystems
-
The common interface for SDK component factories and configuration builders.
- Components - Class in com.launchdarkly.sdk.android
-
Provides configurable factories for the standard implementations of LaunchDarkly component interfaces.
- ConnectionInformation - Interface in com.launchdarkly.sdk.android
-
Provides various information about a current or previous connection.
- ConnectionInformation.ConnectionMode - Enum Class in com.launchdarkly.sdk.android
-
Enumerated type defining the possible values of
ConnectionInformation.getConnectionMode()
. - connectTimeoutMillis - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Connection timeout in millis
- connectTimeoutMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Sets the connection timeout.
- ContextBuilder - Class in com.launchdarkly.sdk
-
A mutable object that uses the builder pattern to specify properties for
LDContext
. - ContextKind - Class in com.launchdarkly.sdk
-
A string identifier provided by the application to describe what kind of entity an
LDContext
represents. - ContextMultiBuilder - Class in com.launchdarkly.sdk
-
A mutable object that uses the builder pattern to specify properties for a multi-kind
LDContext
. - Converter() - Constructor for class com.launchdarkly.sdk.LDValue.Converter
- country(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Set the country for a user.
- COUNTRY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the country attribute.
- create(ContextKind, String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a single-kind LDContext with only the kind and keys specified.
- create(String) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a single-kind LDContext with a kind of
ContextKind.DEFAULT
} and the specified key. - createApplicationInfo() - Method in class com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder
-
Called internally by the SDK to create the configuration object.
- createMulti(LDContext...) - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a multi-kind LDContext out of the specified single-kind LDContexts.
- createServiceEndpoints() - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Called internally by the SDK to create a configuration instance.
- custom(String, boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a boolean-valued custom attribute.
- custom(String, double) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds a double-precision numeric custom attribute.
- custom(String, int) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds an integer-valued custom attribute.
- custom(String, LDValue) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a custom attribute whose value can be any JSON type, using
LDValue
. - custom(String, String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Adds a
String
-valued custom attribute.
D
- DataModel - Class in com.launchdarkly.sdk.android
-
Contains information about the internal data model for feature flag state.
- DataModel.Flag - Class in com.launchdarkly.sdk.android
-
Represents the state of a feature flag evaluation received from LaunchDarkly.
- dataSource() - Static method in class com.launchdarkly.sdk.android.integrations.TestData
-
Creates a new instance of the test data source.
- dataSource(ComponentConfigurer<DataSource>) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the configuration of the component that receives feature flag data from LaunchDarkly.
- DataSource - Interface in com.launchdarkly.sdk.android.subsystems
-
Interface for an object that receives updates to feature flags from LaunchDarkly.
- DataSourceUpdateSink - Interface in com.launchdarkly.sdk.android.subsystems
-
Interface that an implementation of
DataSource
will use to push data into the SDK. - DEBUG - Static variable in class com.launchdarkly.sdk.android.BuildConfig
- DEBUG - Static variable in class com.launchdarkly.sdk.android.test.BuildConfig
- DEFAULT - Static variable in class com.launchdarkly.sdk.ContextKind
-
A constant for the default kind of "user".
- DEFAULT_BACKGROUND_POLL_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.LDConfig
-
The default value for
StreamingDataSourceBuilder.backgroundPollIntervalMillis(int)
andPollingDataSourceBuilder.backgroundPollIntervalMillis(int)
: one hour. - DEFAULT_CAPACITY - Static variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The default value for
EventProcessorBuilder.capacity(int)
. - DEFAULT_CONNECT_TIMEOUT_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
The default value for
HttpConfigurationBuilder.connectTimeoutMillis(int)
: ten seconds. - DEFAULT_DIAGNOSTIC_RECORDING_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The default value for
EventProcessorBuilder.diagnosticRecordingIntervalMillis(int)
: 15 minutes. - DEFAULT_FLUSH_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The default value for
EventProcessorBuilder.flushIntervalMillis(int)
: 30 seconds. - DEFAULT_INITIAL_RECONNECT_DELAY_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
The default value for
StreamingDataSourceBuilder.initialReconnectDelayMillis(int)
: 1000 milliseconds. - DEFAULT_LOGGER_NAME - Static variable in class com.launchdarkly.sdk.android.LDPackageConsts
-
Name the logger will use to identify this SDK.
- DEFAULT_POLL_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
The default value for
PollingDataSourceBuilder.pollIntervalMillis(int)
: 5 minutes. - deletedItemPlaceholder(String, int) - Static method in class com.launchdarkly.sdk.android.DataModel.Flag
- describeConfiguration(ClientContext) - Method in interface com.launchdarkly.sdk.android.subsystems.DiagnosticDescription
-
Used internally by the SDK to inspect the configuration.
- deserialize(String, Class<T>) - Static method in class com.launchdarkly.sdk.json.JsonSerialization
-
Parses an object from its JSON representation.
- DiagnosticDescription - Interface in com.launchdarkly.sdk.android.subsystems
-
Optional interface for components to describe their own configuration.
- diagnosticOptOut(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Set to true to opt out of sending diagnostics data.
- diagnosticRecordingIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The diagnostic interval in millis
- diagnosticRecordingIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Sets the interval at which periodic diagnostic data is sent.
- disableBackgroundUpdating(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets whether feature flag updates should be disabled when your app is in the background.
- Disabled - Enum constant in enum class com.launchdarkly.sdk.android.LDConfig.Builder.AutoEnvAttributes
-
Disables the Auto EnvironmentAttributes functionality.
- Double - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for doubles. - doubleValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
double
if it is numeric. - doubleVariation(String, double) - Method in class com.launchdarkly.sdk.android.LDClient
- doubleVariation(String, double) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the double-precision floating-point numeric value of a feature flag for the current evaluation context.
- doubleVariationDetail(String, double) - Method in class com.launchdarkly.sdk.android.LDClient
- doubleVariationDetail(String, double) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the double-precision floating-point numeric value of a feature flag for the current evaluation context, along with information about how it was calculated.
E
- email(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's e-mail address.
- EMAIL - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the user key attribute.
- enableCollectionFromPlatform(Application) - Method in class com.launchdarkly.sdk.android.env.EnvironmentReporterBuilder
-
Enables automatically collecting attributes from the platform.
- Enabled - Enum constant in enum class com.launchdarkly.sdk.android.LDConfig.Builder.AutoEnvAttributes
-
Enables the Auto EnvironmentAttributes functionality.
- EnvironmentReporterBuilder - Class in com.launchdarkly.sdk.android.env
-
Builder for making an
IEnvironmentReporter
with various options. - EnvironmentReporterBuilder() - Constructor for class com.launchdarkly.sdk.android.env.EnvironmentReporterBuilder
- equals(Object) - Method in class com.launchdarkly.sdk.android.DataModel.Flag
- equals(Object) - Method in class com.launchdarkly.sdk.AttributeRef
- equals(Object) - Method in class com.launchdarkly.sdk.ContextKind
- equals(Object) - Method in class com.launchdarkly.sdk.EvaluationDetail
- equals(Object) - Method in class com.launchdarkly.sdk.EvaluationReason
- equals(Object) - Method in class com.launchdarkly.sdk.LDContext
- equals(Object) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- equals(Object) - Method in class com.launchdarkly.sdk.LDValue
-
Returns true if the other object is an
LDValue
that is logically equal. - equals(Object) - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- error(EvaluationReason.ErrorKind) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.ERROR
. - error(EvaluationReason.ErrorKind, LDValue) - Static method in class com.launchdarkly.sdk.EvaluationDetail
-
Shortcut for creating an instance with an error result.
- ERROR - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag could not be evaluated, e.g.
- EvaluationDetail<T> - Class in com.launchdarkly.sdk
-
An object returned by the SDK's "variation detail" methods such as
boolVariationDetail
, combining the result of a flag evaluation with an explanation of how it was calculated. - EvaluationReason - Class in com.launchdarkly.sdk
-
Describes the reason that a flag evaluation produced a particular value.
- EvaluationReason.BigSegmentsStatus - Enum Class in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getBigSegmentsStatus()
. - EvaluationReason.ErrorKind - Enum Class in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getErrorKind()
. - EvaluationReason.Kind - Enum Class in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getKind()
. - evaluationReasons(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
If enabled, LaunchDarkly will provide additional information about how flag values were calculated.
- EventProcessor - Interface in com.launchdarkly.sdk.android.subsystems
-
Interface for an object that can send or store analytics events.
- EventProcessorBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring delivery of analytics events.
- EventProcessorBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
- events(ComponentConfigurer<EventProcessor>) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the implementation of
EventProcessor
to be used for processing analytics events. - events(String) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.events(URI)
, specifying the URI as a string. - events(URI) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Sets a custom base URI for the events service.
- eventsBaseUri - Variable in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Base URI for events
- exception(Exception) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.ERROR
, with an exception instance. - EXCEPTION - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that an unexpected exception stopped flag evaluation.
F
- fallthrough() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.FALLTHROUGH
. - fallthrough(boolean) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.FALLTHROUGH
and where the inExperiment parameter represents whether the evaluation was part of an experiment. - FALLTHROUGH - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was on but the user did not match any targets or rules.
- FeatureFlagChangeListener - Interface in com.launchdarkly.sdk.android
-
Callback interface used for listening to changes to a feature flag.
- FIRST_NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the first name attribute.
- firstName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's first name
- flag(String) - Method in class com.launchdarkly.sdk.android.integrations.TestData
-
Creates or copies a
TestData.FlagBuilder
for building a test flag configuration. - Flag(String, LDValue, int, Integer, Integer, boolean, boolean, Long, EvaluationReason, String[]) - Constructor for class com.launchdarkly.sdk.android.DataModel.Flag
-
Constructs an instance, specifying all properties.
- FLAG_NOT_FOUND - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller provided a flag key that did not match any known flag.
- Float - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for floats. - floatValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
float
if it is numeric. - flush() - Method in class com.launchdarkly.sdk.android.LDClient
- flush() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Sends all pending events to LaunchDarkly.
- flush() - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Specifies that any buffered events should be sent as soon as possible, rather than waiting for the next flush interval.
- flushIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The flush interval in millis
- flushIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Sets the interval between flushes of the event buffer.
- forName(String) - Static method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns a UserAttribute instance for the specified attribute name.
- fromJson(String) - Static method in class com.launchdarkly.sdk.android.DataModel.Flag
-
Deserializes a flag from JSON to
DataModel.Flag
- fromLiteral(String) - Static method in class com.launchdarkly.sdk.AttributeRef
-
Similar to
AttributeRef.fromPath(String)
, except that it always interprets the string as a literal attribute name, never as a slash-delimited path expression. - fromPath(String) - Static method in class com.launchdarkly.sdk.AttributeRef
-
Creates an AttributeRef from a string.
- fromType(T) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Converts a value of the specified type to an
LDValue
. - fromUser(LDUser) - Static method in class com.launchdarkly.sdk.LDContext
-
Deprecated.
- fromValue(T, int, EvaluationReason) - Static method in class com.launchdarkly.sdk.EvaluationDetail
-
Factory method for an arbitrary value.
G
- generateAnonymousKeys(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Set to
true
to make the SDK provide unique keys for anonymous contexts. - get() - Static method in class com.launchdarkly.sdk.android.LDClient
-
Returns the
LDClient
instance that was previously created withLDClient.init(Application, LDConfig, LDContext, int)
orLDClient.init(Application, LDConfig, LDContext)
. - get(int) - Method in class com.launchdarkly.sdk.LDValue
-
Returns an array element by index.
- get(String) - Method in class com.launchdarkly.sdk.LDValue
-
Returns an object property by name.
- getAllNamespaces() - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Returns all namespaces that exist in the data store.
- getApplicationId() - Method in class com.launchdarkly.sdk.android.subsystems.ApplicationInfo
-
A unique identifier representing the application where the LaunchDarkly SDK is running.
- getApplicationInfo() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getApplicationName() - Method in class com.launchdarkly.sdk.android.subsystems.ApplicationInfo
-
A human friendly name for the application in which the LaunchDarkly SDK is running.
- getApplicationVersion() - Method in class com.launchdarkly.sdk.android.subsystems.ApplicationInfo
-
A unique identifier representing the version of the application where the LaunchDarkly SDK is running.
- getApplicationVersionName() - Method in class com.launchdarkly.sdk.android.subsystems.ApplicationInfo
-
A human friendly name for the version of the application in which the LaunchDarkly SDK is running.
- getAttribute(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Gets the value of a user attribute, if present.
- getAvatar() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the avatar property for the user, if set.
- getBaseLogger() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
The base logger for the SDK.
- getBigSegmentsStatus() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Describes the validity of Big Segment information, if and only if the flag evaluation required querying at least one Big Segment.
- getComponent(int) - Method in class com.launchdarkly.sdk.AttributeRef
-
Retrieves a single path component from the attribute reference.
- getConfig() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the full configuration object.
- getConnectionInformation() - Method in class com.launchdarkly.sdk.android.LDClient
- getConnectionInformation() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Gets a
ConnectionInformation
object from the client representing the current state of the clients connection. - getConnectionMode() - Method in interface com.launchdarkly.sdk.android.ConnectionInformation
- getConnectTimeoutMillis() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
The connection timeout.
- getCountry() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the country property for the user, if set.
- getCustomAttributeNames() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the names of all non-built-in attributes that have been set in this context.
- getCustomAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns an enumeration of all custom attribute names that were set for this user.
- getDataSourceUpdateSink() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
- getDefaultHeaders() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
Returns the basic headers that should be added to all HTTP requests from SDK components to LaunchDarkly services, based on the current SDK configuration.
- getDepth() - Method in class com.launchdarkly.sdk.AttributeRef
-
The number of path components in the AttributeRef.
- getEmail() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the email property for the user, if set.
- getEnvironmentName() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the configured environment name.
- getEnvironmentReporter() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
- getError() - Method in class com.launchdarkly.sdk.AttributeRef
-
Null for a valid AttributeRef, or a non-null error message for an invalid AttributeRef.
- getError() - Method in class com.launchdarkly.sdk.LDContext
-
Returns null for a valid LDContext, or an error message for an invalid one.
- getErrorKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
An enumeration value indicating the general category of error, if the
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - getEvaluationContext() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the current evaluation context as of the time that this component was created.
- getEventsBaseUri() - Method in class com.launchdarkly.sdk.android.interfaces.ServiceEndpoints
-
The base URI for the events service.
- getException() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The exception that caused the error condition, if the
kind
isEvaluationReason.Kind.ERROR
and theerrorKind
isEvaluationReason.ErrorKind.EXCEPTION
. - getFailureType() - Method in exception com.launchdarkly.sdk.android.LDFailure
- getFirstName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the first name property for the user, if set.
- getForMobileKey(String) - Static method in class com.launchdarkly.sdk.android.LDClient
-
Returns the
LDClient
instance that was previously created withLDClient.init(Application, LDConfig, LDContext, int)
orLDClient.init(Application, LDConfig, LDContext)
, for a specific environment. - getFullyQualifiedKey() - Method in class com.launchdarkly.sdk.LDContext
-
Returns a string that describes the LDContext uniquely based on
kind
andkey
values. - getHeaderTransform() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
Returns the callback for modifying request headers, if any.
- getHttp() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the HTTP configuration.
- getIndividualContext(int) - Method in class com.launchdarkly.sdk.LDContext
-
Returns the single-kind LDContext corresponding to one of the kinds in this context.
- getIndividualContext(ContextKind) - Method in class com.launchdarkly.sdk.LDContext
-
Returns the single-kind LDContext corresponding to one of the kinds in this context.
- getIndividualContext(String) - Method in class com.launchdarkly.sdk.LDContext
-
Same as
LDContext.getIndividualContext(ContextKind)
, but specifies the kind as a plain string. - getIndividualContextCount() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the number of context kinds in this context.
- getIp() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the IP property for the user, if set.
- getKey() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
key
attribute. - getKey() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the user's unique key.
- getKeys(String) - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Returns all keys that exist in the namespace.
- getKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an enum indicating the general category of the reason.
- getKind() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
kind
attribute. - getLastFailedConnection() - Method in interface com.launchdarkly.sdk.android.ConnectionInformation
- getLastFailure() - Method in interface com.launchdarkly.sdk.android.ConnectionInformation
- getLastName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the last name property for the user, if set.
- getLastSuccessfulConnection() - Method in interface com.launchdarkly.sdk.android.ConnectionInformation
- getLocale() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getManufacturer() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getMobileKey() - Method in class com.launchdarkly.sdk.android.LDConfig
- getMobileKey() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the configured mobile key.
- getMobileKeys() - Method in class com.launchdarkly.sdk.android.LDConfig
- getModel() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getName() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the context's
name
attribute. - getName() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns the value of the full name property for the user, if set.
- getName() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns the case-sensitive attribute name.
- getOSFamily() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getOSName() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getOSVersion() - Method in interface com.launchdarkly.sdk.android.env.IEnvironmentReporter
- getPollingBaseUri() - Method in class com.launchdarkly.sdk.android.interfaces.ServiceEndpoints
-
The base URI for the polling service.
- getPrerequisiteKey() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The key of the prerequisite flag that did not return the desired variation, if the
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - getPreviouslyInBackground() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the previous background state.
- getPrivateAttribute(int) - Method in class com.launchdarkly.sdk.LDContext
-
Retrieves one of the private attribute references that were specified for this context.
- getPrivateAttributeCount() - Method in class com.launchdarkly.sdk.LDContext
-
Returns the number of private attribute references that were specified for this context.
- getPrivateAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns an enumeration of all attributes that were marked private for this user.
- getReason() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
An object describing the main factor that influenced the flag evaluation value.
- getResponseCode() - Method in exception com.launchdarkly.sdk.android.LDInvalidResponseCodeFailure
- getRuleId() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The unique identifier of the rule that was matched, if the
kind
isEvaluationReason.Kind.RULE_MATCH
. - getRuleIndex() - Method in class com.launchdarkly.sdk.EvaluationReason
-
The index of the rule that was matched (0 for the first rule in the feature flag), if the
kind
isEvaluationReason.Kind.RULE_MATCH
. - getServiceEndpoints() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns the base service URIs used by SDK components.
- getStreamingBaseUri() - Method in class com.launchdarkly.sdk.android.interfaces.ServiceEndpoints
-
The base URI for the streaming service.
- getType() - Method in class com.launchdarkly.sdk.LDValue
-
Gets the JSON type for this value.
- getValue() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
The result of the flag evaluation.
- getValue(AttributeRef) - Method in class com.launchdarkly.sdk.LDContext
-
Looks up the value of any attribute of the context, or a value contained within an attribute, based on an
AttributeRef
. - getValue(String) - Method in class com.launchdarkly.sdk.LDContext
-
Looks up the value of any attribute of the context by name.
- getValue(String, String) - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Attempts to retrieve a string value from the store.
- getVariationIndex() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
The index of the returned value within the flag's list of variations, e.g.
- getVersion() - Method in class com.launchdarkly.sdk.android.LDClient
- getVersion() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the version of the SDK, for instance "2.7.0".
H
- hashCode() - Method in class com.launchdarkly.sdk.AttributeRef
- hashCode() - Method in class com.launchdarkly.sdk.ContextKind
- hashCode() - Method in class com.launchdarkly.sdk.EvaluationDetail
- hashCode() - Method in class com.launchdarkly.sdk.EvaluationReason
- hashCode() - Method in class com.launchdarkly.sdk.LDContext
- hashCode() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- hashCode() - Method in class com.launchdarkly.sdk.LDValue
- hashCode() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- headerTransform - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
LDHeaderUpdater
that will be applied to requests - headerTransform(LDHeaderUpdater) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Provides a callback for dynamically modifying headers used on requests to LaunchDarkly services.
- HEALTHY - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation was successful, and that the segment state is considered up to date.
- http(ComponentConfigurer<HttpConfiguration>) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the SDK's networking configuration, using a configuration builder.
- httpConfiguration() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration builder for the SDK's networking configuration.
- HttpConfiguration - Class in com.launchdarkly.sdk.android.subsystems
-
Encapsulates top-level HTTP configuration that applies to all SDK components.
- HttpConfiguration(int, Map<String, String>, LDHeaderUpdater, boolean) - Constructor for class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
Creates an instance.
- HttpConfigurationBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring the SDK's networking behavior.
- HttpConfigurationBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
I
- IContextModifier - Interface in com.launchdarkly.sdk.android
-
Modifies contexts when invoked.
- identify(LDContext) - Method in class com.launchdarkly.sdk.android.LDClient
- identify(LDContext) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Changes the current evaluation context, requests flags for that context from LaunchDarkly if we are online, and generates an analytics event to tell LaunchDarkly about the context.
- IEnvironmentReporter - Interface in com.launchdarkly.sdk.android.env
-
Reports information about the software/hardware environment that the SDK is executing within.
- init(Application, LDConfig, LDContext) - Static method in class com.launchdarkly.sdk.android.LDClient
-
Deprecated.Initializing the
LDClient
without a timeout is no longer permitted to help prevent consumers from blocking their application execution by mistake when connectivity is poor. Please useLDClient.init(Application, LDConfig, LDContext, int)
and specify a timeout instead. - init(Application, LDConfig, LDContext, int) - Static method in class com.launchdarkly.sdk.android.LDClient
-
Initializes the singleton instance and blocks for up to
startWaitSeconds
seconds until the client has been initialized. - init(LDContext, Map<String, DataModel.Flag>) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSourceUpdateSink
-
Completely overwrites the current contents of the data store with a new set of items.
- initialReconnectDelayMillis - Variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
The initial reconnection delay in millis
- initialReconnectDelayMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
Sets the initial reconnect delay for the streaming connection.
- Integer - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for integers. - intValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as an
int
if it is numeric. - intVariation(String, int) - Method in class com.launchdarkly.sdk.android.LDClient
- intVariation(String, int) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the integer value of a feature flag for the current evaluation context.
- intVariationDetail(String, int) - Method in class com.launchdarkly.sdk.android.LDClient
- intVariationDetail(String, int) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the integer value of a feature flag for the current evaluation context, along with information about how it was calculated.
- INVALID_RESPONSE_BODY - Enum constant in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
A response body received either through polling or streaming was unable to be parsed.
- ip(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the IP for a user.
- IP - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the IP address attribute.
- isAnonymous() - Method in class com.launchdarkly.sdk.LDContext
-
Returns true if this context is only intended for flag evaluations and will not be indexed by LaunchDarkly.
- isAnonymous() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Returns true if this user was marked anonymous.
- isAttributePrivate(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.Tests whether an attribute has been marked private for this user.
- isAutoEnvAttributes() - Method in class com.launchdarkly.sdk.android.LDConfig
- isBuiltIn() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Returns true for a built-in attribute or false for a custom attribute.
- isDefault() - Method in class com.launchdarkly.sdk.ContextKind
-
True if this is equal to
ContextKind.DEFAULT
("user"). - isDefaultValue() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
Returns true if the flag evaluation returned the default value, rather than one of the flag's variations.
- isDisableBackgroundPolling() - Method in class com.launchdarkly.sdk.android.LDClient
- isDisableBackgroundPolling() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Checks whether
LDConfig.Builder.disableBackgroundUpdating(boolean)
was set totrue
in the configuration. - isDisableBackgroundPolling() - Method in class com.launchdarkly.sdk.android.LDConfig
- isEvaluationReasons() - Method in class com.launchdarkly.sdk.android.LDConfig
- isEvaluationReasons() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns true if evaluation reasons are enabled.
- isGenerateAnonymousKeys() - Method in class com.launchdarkly.sdk.android.LDConfig
- isInBackground() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns true if the application was in the background at the time that this component was created.
- isInExperiment() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Whether the evaluation was part of an experiment.
- isInitialized() - Method in class com.launchdarkly.sdk.android.LDClient
- isInitialized() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Checks whether the client is ready to return feature flag values.
- isInt() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a number that is also an integer.
- isMultiple() - Method in class com.launchdarkly.sdk.LDContext
-
Returns true if this is a multi-kind context.
- isNull() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a null.
- isNumber() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a number (not a numeric string).
- isOffline() - Method in class com.launchdarkly.sdk.android.LDClient
- isOffline() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Checks whether the client has been put into offline mode.
- isOffline() - Method in class com.launchdarkly.sdk.android.LDConfig
- isRetryable() - Method in exception com.launchdarkly.sdk.android.LDInvalidResponseCodeFailure
- isSetOffline() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns true if the application has specified that the SDK should be offline.
- isString() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a string.
- isUseReport() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
The setting for whether to use the HTTP REPORT method.
- isValid() - Method in class com.launchdarkly.sdk.AttributeRef
-
True for a valid AttributeRef, false for an invalid AttributeRef.
- isValid() - Method in class com.launchdarkly.sdk.LDContext
-
Returns
true
for a valid LDContext,false
for an invalid one.
J
- JsonSerializable - Interface in com.launchdarkly.sdk.json
-
Marker interface for SDK classes that have a custom JSON serialization.
- JsonSerialization - Class in com.launchdarkly.sdk.json
-
Helper methods for JSON serialization of SDK classes.
- jsonValueVariation(String, LDValue) - Method in class com.launchdarkly.sdk.android.LDClient
- jsonValueVariation(String, LDValue) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the value of a feature flag for the current evaluation context, which may be of any type.
- jsonValueVariationDetail(String, LDValue) - Method in class com.launchdarkly.sdk.android.LDClient
- jsonValueVariationDetail(String, LDValue) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the value of a feature flag for the current evaluation context, which may be of any type, along with information about how it was calculated.
K
- key(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's key attribute.
- key(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Changes the user's key.
- KEY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the user key attribute.
- keys() - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the property names in an object.
- kind(ContextKind) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's kind attribute.
- kind(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's kind attribute, as a string.
L
- LAST_NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the last name attribute.
- lastName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's last name.
- LaunchDarklyException - Exception in com.launchdarkly.sdk.android
-
Exception class that can be thrown by LaunchDarkly client methods.
- LaunchDarklyException(String) - Constructor for exception com.launchdarkly.sdk.android.LaunchDarklyException
- LDAllFlagsListener - Interface in com.launchdarkly.sdk.android
-
Callback interface used for listening to changes to the flag store.
- LDAndroidLogging - Class in com.launchdarkly.sdk.android
-
Allows LaunchDarkly log output to be sent directly to the native Android Log API.
- LDAndroidLogging() - Constructor for class com.launchdarkly.sdk.android.LDAndroidLogging
- LDClient - Class in com.launchdarkly.sdk.android
-
Client for accessing LaunchDarkly's Feature Flag system.
- LDClient(PlatformState, IEnvironmentReporter, TaskExecutor, PersistentDataStoreWrapper.PerEnvironmentData, LDContext, LDConfig, String, String) - Constructor for class com.launchdarkly.sdk.android.LDClient
- LDClientInterface - Interface in com.launchdarkly.sdk.android
-
The interface for the LaunchDarkly SDK client.
- LDConfig - Class in com.launchdarkly.sdk.android
-
This class exposes advanced configuration options for
LDClient
. - LDConfig.Builder - Class in com.launchdarkly.sdk.android
- LDConfig.Builder.AutoEnvAttributes - Enum Class in com.launchdarkly.sdk.android
-
Enable / disable options for Auto Environment Attributes functionality.
- LDContext - Class in com.launchdarkly.sdk
-
A collection of attributes that can be referenced in flag evaluations and analytics events.
- LDFailure - Exception in com.launchdarkly.sdk.android
-
Container class representing a communication failure with LaunchDarkly servers.
- LDFailure(String, LDFailure.FailureType) - Constructor for exception com.launchdarkly.sdk.android.LDFailure
- LDFailure(String, Throwable, LDFailure.FailureType) - Constructor for exception com.launchdarkly.sdk.android.LDFailure
- LDFailure.FailureType - Enum Class in com.launchdarkly.sdk.android
-
Enumerated type defining the possible values of
LDFailure.getFailureType()
. - LDGson - Class in com.launchdarkly.sdk.json
-
A helper class for interoperability with application code that uses Gson.
- LDHeaderUpdater - Interface in com.launchdarkly.sdk.android
-
An interface to provide the SDK with a function used to modify HTTP headers before each request to the LaunchDarkly service.
- LDInvalidResponseCodeFailure - Exception in com.launchdarkly.sdk.android
-
Container class representing a communication failure with LaunchDarkly servers in which the response was unexpected.
- LDInvalidResponseCodeFailure(String, int, boolean) - Constructor for exception com.launchdarkly.sdk.android.LDInvalidResponseCodeFailure
- LDInvalidResponseCodeFailure(String, Throwable, int, boolean) - Constructor for exception com.launchdarkly.sdk.android.LDInvalidResponseCodeFailure
- LDJackson - Class in com.launchdarkly.sdk.json
-
A helper class for interoperability with application code that uses Jackson.
- LDPackageConsts - Class in com.launchdarkly.sdk.android
-
Constants related to the SDK package
- LDPackageConsts() - Constructor for class com.launchdarkly.sdk.android.LDPackageConsts
- LDStatusListener - Interface in com.launchdarkly.sdk.android
-
Listener for various SDK state changes.
- LDTimberLogging - Class in com.launchdarkly.sdk.android
-
Allows LaunchDarkly log output to be forwarded to Timber.
- LDTimberLogging() - Constructor for class com.launchdarkly.sdk.android.LDTimberLogging
- LDTimberLogging.Adapter - Class in com.launchdarkly.sdk.android
-
A Timber implementation of the
LDLogAdapter
interface. - LDUser - Class in com.launchdarkly.sdk
-
Deprecated.use
LDContext
instead. - LDUser(LDUser.Builder) - Constructor for class com.launchdarkly.sdk.LDUser
-
Deprecated.
- LDUser(String) - Constructor for class com.launchdarkly.sdk.LDUser
-
Deprecated.Create a user with the given key
- LDUser.Builder - Class in com.launchdarkly.sdk
-
Deprecated.
- LDUtil - Class in com.launchdarkly.sdk.android
-
Various utility functions
- LDUtil() - Constructor for class com.launchdarkly.sdk.android.LDUtil
- LDValue - Class in com.launchdarkly.sdk
-
An immutable instance of any data type that is allowed in JSON.
- LDValue() - Constructor for class com.launchdarkly.sdk.LDValue
- LDValue.Convert - Class in com.launchdarkly.sdk
-
Predefined instances of
LDValue.Converter
for commonly used types. - LDValue.Converter<T> - Class in com.launchdarkly.sdk
-
Defines a conversion between
LDValue
and some other type. - LDValueType - Enum Class in com.launchdarkly.sdk
-
Describes the type of an
LDValue
. - LIBRARY_PACKAGE_NAME - Static variable in class com.launchdarkly.sdk.android.BuildConfig
- logAdapter(LDLogAdapter) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Specifies the implementation of logging to use.
- loggerName(String) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Specifies a custom logger name/tag for the SDK.
- logLevel(LDLogLevel) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Specifies the lowest level of logging to enable.
- Long - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for long integers. - longValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
long
if it is numeric.
M
- MALFORMED_FLAG - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that there was an internal inconsistency in the flag data, e.g.
- maxCachedContexts(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the maximum number of evaluation contexts to cache the flag values for locally in the device's SharedPreferences.
- MIN_BACKGROUND_POLL_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.LDConfig
-
The minimum value for
StreamingDataSourceBuilder.backgroundPollIntervalMillis(int)
andPollingDataSourceBuilder.backgroundPollIntervalMillis(int)
: 15 minutes. - MIN_DIAGNOSTIC_RECORDING_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
The minimum value for
EventProcessorBuilder.diagnosticRecordingIntervalMillis(int)
: 5 minutes. - mobileKey(String) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the key for authenticating with LaunchDarkly.
- modifyContext(LDContext) - Method in class com.launchdarkly.sdk.android.AutoEnvContextModifier
- modifyContext(LDContext) - Method in interface com.launchdarkly.sdk.android.IContextModifier
-
Modifies the provided context and returns a resulting context.
- modifyContext(LDContext) - Method in class com.launchdarkly.sdk.android.NoOpContextModifier
- module() - Static method in class com.launchdarkly.sdk.json.LDJackson
-
Returns a Jackson
Module
that defines the correct serialization and deserialization behavior for all LaunchDarkly SDK objects that implementJsonSerializable
. - MULTI - Static variable in class com.launchdarkly.sdk.ContextKind
-
A constant for the kind that all multi-kind contexts have.
- multiBuilder() - Static method in class com.launchdarkly.sdk.LDContext
-
Creates a
ContextMultiBuilder
for building a multi-kind context.
N
- name(String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the context's name attribute.
- name(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's full name.
- NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.Represents the full name attribute.
- needsRefresh(boolean, LDContext) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
The SDK calls this method to determine whether it needs to stop the current data source and start a new one after a state transition.
- NETWORK_FAILURE - Enum constant in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
A network request for polling, or the EventSource stream reported a failure.
- newChannel(String) - Method in class com.launchdarkly.sdk.android.LDTimberLogging.Adapter
- NO_VARIATION - Static variable in class com.launchdarkly.sdk.EvaluationDetail
-
If
EvaluationDetail.getVariationIndex()
is equal to this constant, it means no variation was chosen (evaluation failed and returned a default value). - NO_VERSION - Static variable in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
- noEvents() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration object that disables analytics events.
- NoOpContextModifier - Class in com.launchdarkly.sdk.android
-
Context modifier that does nothing to the context.
- NoOpContextModifier() - Constructor for class com.launchdarkly.sdk.android.NoOpContextModifier
- normalize(LDValue) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns the same value if non-null, or
LDValue.ofNull()
if null. - NOT_CONFIGURED - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that Big Segments could not be queried for the flag evaluation because the SDK configuration did not include a Big Segment store.
- NULL - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is null.
- NUMBER - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is numeric.
O
- OBJECT - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is an object (map).
- ObjectBuilder - Class in com.launchdarkly.sdk
-
A builder created by
LDValue.buildObject()
. - ObjectBuilder() - Constructor for class com.launchdarkly.sdk.ObjectBuilder
- objectFrom(Map<String, T>) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Initializes an
LDValue
as an object, from a map containing this type. - of(boolean) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a boolean value.
- of(double) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(float) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(int) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(long) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a numeric value.
- of(String) - Static method in class com.launchdarkly.sdk.ContextKind
-
Constructor from a string value.
- of(String) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a string value (or a null).
- off() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.OFF
. - OFF - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was off and therefore returned its configured off value.
- offline(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Disables all network calls from the LaunchDarkly client.
- OFFLINE - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK has detected that the mobile device does not have an active network connection.
- ofNull() - Static method in class com.launchdarkly.sdk.LDValue
-
Returns an instance for a null value.
- onChange(List<String>) - Method in interface com.launchdarkly.sdk.android.LDAllFlagsListener
-
Called by the SDK whenever it receives an update for the stored flag values of the current context.
- onConnectionModeChanged(ConnectionInformation) - Method in interface com.launchdarkly.sdk.android.LDStatusListener
-
Invoked when the connection mode changes
- onError(Throwable) - Method in interface com.launchdarkly.sdk.android.subsystems.Callback
-
This method is called on failure.
- onFeatureFlagChange(String) - Method in interface com.launchdarkly.sdk.android.FeatureFlagChangeListener
-
The SDK calls this method when a feature flag value has changed for the current evaluation context.
- onInternalFailure(LDFailure) - Method in interface com.launchdarkly.sdk.android.LDStatusListener
-
Invoked when an internal issue results in a failure to connect to LaunchDarkly
- onSuccess(T) - Method in interface com.launchdarkly.sdk.android.subsystems.Callback
-
This method is called on successful completion.
P
- parse(String) - Static method in class com.launchdarkly.sdk.LDValue
-
Parses an LDValue from a JSON representation.
- PersistentDataStore - Interface in com.launchdarkly.sdk.android.subsystems
-
Interface for a data store that holds feature flag data and other SDK properties in a simple string format.
- polling(String) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.polling(URI)
, specifying the URI as a string. - polling(URI) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Sets a custom base URI for the polling service.
- POLLING - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK is in foreground polling mode because it was configured with streaming disabled.
- pollingBaseUri - Variable in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Base URI for polling requests
- pollingDataSource() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration builder for using polling mode to get feature flag data.
- PollingDataSourceBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring the polling data source.
- PollingDataSourceBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
- pollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
The foreground polling interval in millis
- pollIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
Sets the interval between feature flag updates when the application is running in the foreground.
- PREREQUISITE_FAILED - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the flag was considered off because it had at least one prerequisite flag that either was off or did not return the desired variation.
- prerequisiteFailed(String) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - privateAttributes - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Set of attributes by reference that will be treated as private
- privateAttributes(AttributeRef...) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Equivalent to
ContextBuilder.privateAttributes(String...)
, but uses theAttributeRef
type. - privateAttributes(String...) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Marks a set of attribute names or subproperties as private.
- privateAttributes(String...) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Designates any number of context attributes, or properties within them, as private: that is, their values will not be recorded by LaunchDarkly.
- privateAvatar(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's avatar, and ensures that the avatar attribute will not be sent back to LaunchDarkly.
- privateCountry(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Set the country for a user, and ensures that the country attribute will not be sent back to LaunchDarkly.
- privateCustom(String, boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a boolean-valued custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, double) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a double-precision numeric custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, int) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add an int-valued custom attribute that will not be sent back to LaunchDarkly.
- privateCustom(String, LDValue) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a custom attribute of any JSON type, that will not be sent back to LaunchDarkly.
- privateCustom(String, String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Add a
String
-valued custom attribute that will not be sent back to LaunchDarkly. - privateEmail(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's e-mail address, and ensures that the e-mail address attribute will not be sent back to LaunchDarkly.
- privateFirstName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's first name, and ensures that the first name attribute will not be sent back to LaunchDarkly.
- privateIp(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the IP for a user, and ensures that the IP attribute is not sent back to LaunchDarkly.
- privateLastName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's last name, and ensures that the last name attribute will not be sent back to LaunchDarkly.
- privateName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Deprecated.Sets the user's full name, and ensures that the name attribute will not be sent back to LaunchDarkly.
- put(String, boolean) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, double) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, float) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, int) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, long) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, LDValue) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
- put(String, String) - Method in class com.launchdarkly.sdk.ObjectBuilder
-
Sets a key-value pair in the builder, overwriting any previous value for that key.
R
- recordCustomEvent(LDContext, String, LDValue, Double) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Creates a custom event, as when the SDK's
track
method is called. - recordEvaluationEvent(LDContext, String, int, int, LDValue, EvaluationReason, LDValue, boolean, Long) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Records the action of evaluating a feature flag.
- recordIdentifyEvent(LDContext) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Registers an evaluation context, as when the SDK's
identify
method is called. - registerAllFlagsListener(LDAllFlagsListener) - Method in class com.launchdarkly.sdk.android.LDClient
- registerAllFlagsListener(LDAllFlagsListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Registers a
LDAllFlagsListener
to be called when a flag update is processed by the SDK. - registerFeatureFlagListener(String, FeatureFlagChangeListener) - Method in class com.launchdarkly.sdk.android.LDClient
- registerFeatureFlagListener(String, FeatureFlagChangeListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Registers a
FeatureFlagChangeListener
to be called when theflagKey
changes from its current value. - registerStatusListener(LDStatusListener) - Method in class com.launchdarkly.sdk.android.LDClient
- registerStatusListener(LDStatusListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Registers a
LDStatusListener
to be called on connection status updates. - relayProxy(String) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.relayProxy(URI)
, specifying the URI as a string. - relayProxy(URI) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Specifies a single base URI for a Relay Proxy instance.
- RULE_MATCH - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the context matched one of the flag's rules.
- ruleMatch(int, String) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.RULE_MATCH
. - ruleMatch(int, String, boolean) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.RULE_MATCH
and where the inExperiment parameter represents whether the evaluation was part of an experiment.
S
- sanitizeSpaces(String) - Static method in class com.launchdarkly.sdk.android.LDUtil
-
Replaces spaces with hyphens.
- SDK_CLIENT_NAME - Static variable in class com.launchdarkly.sdk.android.LDPackageConsts
-
Name that will be used for identifying this SDK when using a network client.
- SDK_NAME - Static variable in class com.launchdarkly.sdk.android.LDPackageConsts
-
Name of the SDK
- SDK_PLATFORM_NAME - Static variable in class com.launchdarkly.sdk.android.LDPackageConsts
-
Name of the platform this SDK is primarily for
- secondaryMobileKeys(Map<String, String>) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the secondary keys for authenticating to additional LaunchDarkly environments.
- sendEvents() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration builder for analytics event delivery.
- SerializationException - Exception in com.launchdarkly.sdk.json
-
General exception class for all errors in serializing or deserializing JSON.
- SerializationException(String) - Constructor for exception com.launchdarkly.sdk.json.SerializationException
-
Creates an instance.
- SerializationException(Throwable) - Constructor for exception com.launchdarkly.sdk.json.SerializationException
-
Creates an instance.
- serialize(T) - Static method in class com.launchdarkly.sdk.json.JsonSerialization
-
Converts an object to its JSON representation.
- serviceEndpoints() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a builder for configuring custom service URIs.
- serviceEndpoints(ServiceEndpointsBuilder) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the base service URIs used by SDK components.
- ServiceEndpoints - Class in com.launchdarkly.sdk.android.interfaces
-
Specifies the base service URIs used by SDK components.
- ServiceEndpoints(URI, URI, URI) - Constructor for class com.launchdarkly.sdk.android.interfaces.ServiceEndpoints
-
Used internally by the SDK to store service endpoints.
- ServiceEndpointsBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring the SDK's service URIs.
- ServiceEndpointsBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
- set(String, boolean) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a boolean value. - set(String, double) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a double-precision numeric value. - set(String, int) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for an integer numeric value. - set(String, LDValue) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Sets the value of any attribute for the context.
- set(String, String) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
for a string value. - SET_OFFLINE - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK has been explicitly set offline, either in the initial configuration, by
LDClient.setOffline()
, or as a result of failed authentication to LaunchDarkly. - setApplicationInfo(ApplicationInfo) - Method in class com.launchdarkly.sdk.android.env.EnvironmentReporterBuilder
-
Sets the application info that this environment reporter will report when asked in the future, overriding the automatically sourced
ApplicationInfo
- setEvaluationContext(LDContext) - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Sets the evaluation context and returns a new instance of
ClientContext
- setInBackground(boolean) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Puts the event processor into background mode if appropriate.
- setOffline() - Method in class com.launchdarkly.sdk.android.LDClient
- setOffline() - Method in interface com.launchdarkly.sdk.android.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. - setOffline(boolean) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Puts the event processor into offline mode if appropriate.
- setOnline() - Method in class com.launchdarkly.sdk.android.LDClient
- setOnline() - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Restores network connectivity for the client, if the client was previously in offline mode.
- setStatus(ConnectionInformation.ConnectionMode, Throwable) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSourceUpdateSink
-
Informs the SDK of a change in the data source's status or the connection mode.
- setValue(String, String, String) - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Attempts to update or remove a string value in the store.
- setValues(String, Map<String, String>) - Method in interface com.launchdarkly.sdk.android.subsystems.PersistentDataStore
-
Attempts to update multiple values atomically.
- shutDown() - Method in interface com.launchdarkly.sdk.android.subsystems.DataSourceUpdateSink
-
Informs the SDK that the data source is being permanently shut down due to an unrecoverable problem reported by LaunchDarkly, such as the mobile key being invalid.
- SHUTDOWN - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The shutdown state indicates the SDK has been permanently shutdown as a result of a call to close().
- size() - Method in class com.launchdarkly.sdk.LDValue
-
Returns the number of elements in an array or object.
- STALE - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation was successful, but that the segment state may not be up to date.
- start(Callback<Boolean>) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Initializes the data source.
- stop(Callback<Void>) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Tells the data source to stop.
- STORE_ERROR - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Indicates that the Big Segment query involved in the flag evaluation failed, for instance due to a database error.
- streamEvenInBackground - Variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
True if the data source will attempt to continue streaming when in the background
- streamEvenInBackground(boolean) - Method in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
Sets whether streaming should be used even if the application is in the background.
- streaming(String) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.streaming(URI)
, specifying the URI as a string. - streaming(URI) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Sets a custom base URI for the streaming service.
- STREAMING - Enum constant in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
The SDK is either connected to the flag stream, or is actively attempting to acquire a connection.
- streamingBaseUri - Variable in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Base URI for streaming requests
- streamingDataSource() - Static method in class com.launchdarkly.sdk.android.Components
-
Returns a configuration builder for using streaming mode to get feature flag data.
- StreamingDataSourceBuilder - Class in com.launchdarkly.sdk.android.integrations
-
Contains methods for configuring the streaming data source.
- StreamingDataSourceBuilder() - Constructor for class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
- String - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for strings. - STRING - Enum constant in enum class com.launchdarkly.sdk.LDValueType
-
The value is a string.
- stringValue() - Method in class com.launchdarkly.sdk.LDValue
-
Returns this value as a
String
if it is a string. - stringVariation(String, String) - Method in class com.launchdarkly.sdk.android.LDClient
- stringVariation(String, String) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the string value of a feature flag for the current evaluation context.
- stringVariationDetail(String, String) - Method in class com.launchdarkly.sdk.android.LDClient
- stringVariationDetail(String, String) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the string value of a feature flag for the current evaluation context, along with information about how it was calculated.
T
- TARGET_MATCH - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the context key was specifically targeted for this flag.
- targetMatch() - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.TARGET_MATCH
. - TestData - Class in com.launchdarkly.sdk.android.integrations
-
A mechanism for providing dynamically updatable feature flag state in a simplified form to an SDK client in test scenarios.
- TestData.FlagBuilder - Class in com.launchdarkly.sdk.android.integrations
-
A builder for feature flag configurations to be used with
TestData
. - TestData.FlagBuilder.VariationFunc<T> - Interface in com.launchdarkly.sdk.android.integrations
-
A functional interface for use with
TestData.FlagBuilder.variationFunc(VariationFunc)
orTestData.FlagBuilder.variationIndexFunc(VariationFunc)
. - toJson() - Method in class com.launchdarkly.sdk.android.DataModel.Flag
- toJsonString() - Method in class com.launchdarkly.sdk.LDValue
-
Converts this value to its JSON serialization.
- toString() - Method in class com.launchdarkly.sdk.android.DataModel.Flag
- toString() - Method in class com.launchdarkly.sdk.AttributeRef
-
Returns the attribute reference as a string, in the same format used by
AttributeRef.fromPath(String)
. - toString() - Method in class com.launchdarkly.sdk.ContextKind
-
Returns the string value of the context kind.
- toString() - Method in class com.launchdarkly.sdk.EvaluationDetail
-
Returns a simple string representation of this instance.
- toString() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns a simple string representation of the reason.
- toString() - Method in class com.launchdarkly.sdk.LDContext
-
Returns a string representation of the context.
- toString() - Method in class com.launchdarkly.sdk.LDUser
-
Deprecated.
- toString() - Method in class com.launchdarkly.sdk.LDValue
-
Returns a string representation of this value.
- toString() - Method in class com.launchdarkly.sdk.UserAttribute
-
Deprecated.
- toType(LDValue) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Converts an
LDValue
to a value of the specified type. - track(String) - Method in class com.launchdarkly.sdk.android.LDClient
- track(String) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Tracks that an application-defined event occurred.
- trackData(String, LDValue) - Method in class com.launchdarkly.sdk.android.LDClient
- trackData(String, LDValue) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Tracks that an application-defined event occurred, and provides additional custom data.
- trackMetric(String, LDValue, double) - Method in class com.launchdarkly.sdk.android.LDClient
- trackMetric(String, LDValue, double) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Tracks that an application-defined event occurred, and provides an additional numeric value for custom metrics.
- trySet(String, LDValue) - Method in class com.launchdarkly.sdk.ContextBuilder
-
Same as
ContextBuilder.set(String, LDValue)
, but returns a boolean indicating whether the attribute was successfully set. - typeAdapters() - Static method in class com.launchdarkly.sdk.json.LDGson
-
Returns a Gson
TypeAdapterFactory
that defines the correct serialization and deserialization behavior for all LaunchDarkly SDK objects that implementJsonSerializable
.
U
- UNEXPECTED_RESPONSE_CODE - Enum constant in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
This indicates the LDFailure is an instance of LDInvalidResponseCodeFailure.
- UNEXPECTED_STREAM_ELEMENT_TYPE - Enum constant in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
An event was received through the stream with an unknown event key.
- UNKNOWN_ERROR - Enum constant in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
Some other issue occurred.
- unregisterAllFlagsListener(LDAllFlagsListener) - Method in class com.launchdarkly.sdk.android.LDClient
- unregisterAllFlagsListener(LDAllFlagsListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Unregisters a
LDAllFlagsListener
so it will no longer be called on flag updates. - unregisterFeatureFlagListener(String, FeatureFlagChangeListener) - Method in class com.launchdarkly.sdk.android.LDClient
- unregisterFeatureFlagListener(String, FeatureFlagChangeListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Unregisters a
FeatureFlagChangeListener
for theflagKey
. - unregisterStatusListener(LDStatusListener) - Method in class com.launchdarkly.sdk.android.LDClient
- unregisterStatusListener(LDStatusListener) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Unregisters a
LDStatusListener
so it will no longer be called on connection status updates. - update(TestData.FlagBuilder) - Method in class com.launchdarkly.sdk.android.integrations.TestData
-
Updates the test data with the specified flag configuration.
- updateHeaders(Map<String, String>) - Method in interface com.launchdarkly.sdk.android.LDHeaderUpdater
-
An application provided method for dynamic configuration of HTTP headers.
- upsert(LDContext, DataModel.Flag) - Method in interface com.launchdarkly.sdk.android.subsystems.DataSourceUpdateSink
-
Updates or inserts an item.
- urlSafeBase64HashedContextId(LDContext) - Static method in class com.launchdarkly.sdk.android.LDUtil
- USER_NOT_SPECIFIED - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the caller passed
null
for the user parameter, or the user lacked a key. - UserAttribute - Class in com.launchdarkly.sdk
- useReport - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Whether or not Http REPORT method will be used
- useReport(boolean) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Sets whether to use the HTTP REPORT method for feature flag requests.
V
- validateStringValue(String) - Static method in class com.launchdarkly.sdk.android.LDUtil
- valueMapToJsonElementMap(Map<T, LDValue>) - Static method in class com.launchdarkly.sdk.json.LDGson
-
Convenience method for converting a map of
LDValue
values to a map of GsonJsonElement
s. - valueOf(String) - Static method in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.android.LDConfig.Builder.AutoEnvAttributes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.launchdarkly.sdk.LDValueType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.launchdarkly.sdk.android.LDConfig.Builder.AutoEnvAttributes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.launchdarkly.sdk.android.LDFailure.FailureType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the values in an array or object.
- values() - Static method in enum class com.launchdarkly.sdk.LDValueType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valuesAs(LDValue.Converter<T>) - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the values in an array or object, converting them to a specific type.
- valueToJsonElement(LDValue) - Static method in class com.launchdarkly.sdk.json.LDGson
-
Returns a Gson
JsonElement
that is equivalent to the specifiedLDValue
. - variation(boolean) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified boolean variation for all contexts by default.
- variation(int) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for all contexts by default.
- variation(LDValue) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for all contexts by default.
- variationForKey(ContextKind, String, boolean) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified boolean variation for a specific context by kind and key, overriding any other defaults.
- variationForKey(ContextKind, String, int) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.
- variationForKey(ContextKind, String, LDValue) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for a specific context by kind and key, overriding any other defaults.
- variationForUser(String, boolean) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified boolean variation for a specific user key, overriding any other defaults.
- variationForUser(String, int) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for a specific user key, overriding any other defaults.
- variationForUser(String, LDValue) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to return the specified variation for a specific user key, overriding any other defaults.
- variationFunc(TestData.FlagBuilder.VariationFunc<Boolean>) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to use a function to determine whether to return true or false for any given context.
- variationIndexFunc(TestData.FlagBuilder.VariationFunc<Integer>) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to use a function to determine the variation index to return for any given context.
- variations(LDValue...) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Changes the allowable variation values for the flag.
- variationValueFunc(TestData.FlagBuilder.VariationFunc<LDValue>) - Method in class com.launchdarkly.sdk.android.integrations.TestData.FlagBuilder
-
Sets the flag to use a function to determine the variation index to return for any given context.
- VERSION_NAME - Static variable in class com.launchdarkly.sdk.android.BuildConfig
- VERSION_NAME - Static variable in class com.launchdarkly.sdk.android.test.BuildConfig
W
- withBigSegmentsStatus(EvaluationReason.BigSegmentsStatus) - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns a copy of this
EvaluationReason
with a specificEvaluationReason.BigSegmentsStatus
value. - wrapper(String, String) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
For use by wrapper libraries to set an identifying name for the wrapper being used.
- wrapperName - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Name of the wrapping library
- wrapperVersion - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Version of the wrapping library
- WRONG_TYPE - Enum constant in enum class com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the result value was not of the requested type, e.g.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
LDContext
directly instead.