A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
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(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.
- alias(LDUser, LDUser) - Method in class com.launchdarkly.sdk.android.LDClient
-
Alias associates two users for analytics purposes.
- allAttributesPrivate - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
- allAttributesPrivate() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual event-related properties are removed from the top-level configuration.
- allAttributesPrivate() - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- allAttributesPrivate(boolean) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Sets whether or not all optional user 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 user.
- anonymous(boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets whether this user is anonymous.
- ANONYMOUS - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the anonymous attribute.
- ARRAY - 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. - autoAliasingOptOut(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Enable this opt-out to disable sending an automatic alias event when
LDClient.identify(LDUser)
is called with a non-anonymous user when the current user is anonymous. - 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
-
Sets the user's avatar.
- AVATAR - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the avatar URL attribute.
B
- BACKGROUND_DISABLED - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- BACKGROUND_POLLING - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- backgroundPollingIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
- backgroundPollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
- backgroundPollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
- 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 - com.launchdarkly.sdk.LDValueType
-
The value is a boolean.
- 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 flag value for the current user.
- boolVariationDetail(String, boolean) - Method in class com.launchdarkly.sdk.android.LDClient
- boolVariationDetail(String, boolean) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the flag value for the current user, along with information about how it was calculated.
- build() - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Called internally by the SDK to create a configuration instance.
- 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.LDUser.Builder
-
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 interface com.launchdarkly.sdk.android.subsystems.ComponentConfigurer
-
Called internally by the SDK to create an implementation instance.
- buildArray() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an array value.
- Builder() - Constructor for class com.launchdarkly.sdk.android.LDConfig.Builder
- Builder(LDUser) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Creates a builder based on an existing user.
- Builder(String) - Constructor for class com.launchdarkly.sdk.LDUser.Builder
-
Creates a builder with the specified key.
- buildObject() - Static method in class com.launchdarkly.sdk.LDValue
-
Starts building an object value.
C
- capacity - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
- capacity(int) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Set the capacity of the events buffer.
- CLIENT_NOT_READY - 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(Application, String, LDLogger, LDConfig, String, boolean, HttpConfiguration, boolean, ServiceEndpoints) - Constructor for class com.launchdarkly.sdk.android.subsystems.ClientContext
- ClientContext(ClientContext) - Constructor for class com.launchdarkly.sdk.android.subsystems.ClientContext
- 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.integrations - package com.launchdarkly.sdk.android.integrations
- com.launchdarkly.sdk.android.subsystems - package com.launchdarkly.sdk.android.subsystems
- com.launchdarkly.sdk.json - package com.launchdarkly.sdk.json
-
Helper classes and methods for interoperability with JSON.
- 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
- ConnectionInformation.ConnectionMode - Enum in com.launchdarkly.sdk.android
-
Enumerated type defining the possible values of
ConnectionInformation.getConnectionMode()
. - connectionTimeoutMillis(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- ConnectivityReceiver - Class in com.launchdarkly.sdk.android
-
Used internally by the SDK.
- ConnectivityReceiver() - Constructor for class com.launchdarkly.sdk.android.ConnectivityReceiver
- connectTimeoutMillis - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
- connectTimeoutMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Sets the connection timeout.
- Converter() - Constructor for class com.launchdarkly.sdk.LDValue.Converter
- country(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Set the country for a user.
- COUNTRY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the country attribute.
- custom(String, boolean) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Add a boolean-valued custom attribute.
- custom(String, double) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Adds a double-precision numeric custom attribute.
- custom(String, int) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Adds an integer-valued custom attribute.
- custom(String, LDValue) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Add a custom attribute whose value can be any JSON type, using
LDValue
. - custom(String, String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Adds a
String
-valued custom attribute.
D
- 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
-
An object that describes how the SDK will obtain feature flag data from LaunchDarkly.
- 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_POLL_INTERVAL_MILLIS - Static variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
-
The default value for
PollingDataSourceBuilder.pollIntervalMillis(int)
: 5 minutes. - 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
- diagnosticRecordingIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Sets the interval at which periodic diagnostic data is sent.
- diagnosticRecordingIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- 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.
- 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 flag value for the current user.
- doubleVariationDetail(String, double) - Method in class com.launchdarkly.sdk.android.LDClient
- doubleVariationDetail(String, double) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the flag value for the current user, along with information about how it was calculated.
E
- email(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the user's e-mail address.
- EMAIL - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the user key attribute.
- 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.LDUser
- 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
- 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 - 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.ErrorKind - Enum in com.launchdarkly.sdk
-
Enumerated type defining the possible values of
EvaluationReason.getErrorKind()
. - EvaluationReason.Kind - Enum 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(Uri) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.events(URI)
, specifying the URI as anandroid.net.Uri
. - 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
- eventsCapacity(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- eventsFlushIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- eventsUri(Uri) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- exception(Exception) - Static method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an instance whose
kind
isEvaluationReason.Kind.ERROR
, with an exception instance. - EXCEPTION - 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 - 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
-
Represents the first name attribute.
- firstName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the user's first name
- FLAG_NOT_FOUND - 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
- 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
-
Returns a UserAttribute instance for the specified attribute name.
- fromType(T) - Method in class com.launchdarkly.sdk.LDValue.Converter
-
Converts a value of the specified type to an
LDValue
. - fromValue(T, int, EvaluationReason) - Static method in class com.launchdarkly.sdk.EvaluationDetail
-
Factory method for an arbitrary value.
G
- get() - Static method in class com.launchdarkly.sdk.android.LDClient
- 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.
- getApplication() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
The Android application object.
- getAttribute(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Gets the value of a user attribute, if present.
- getAvatar() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the avatar property for the user, if set.
- getBackgroundPollingIntervalMillis() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual data source properties are removed from the top-level configuration.
- getBackgroundPollIntervalMillis() - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Returns the configured background polling interval.
- getBaseLogger() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
The base logger for the SDK.
- 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
- getConnectionTimeoutMillis() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual HTTP-related properties are removed from the top-level configuration.
- getConnectTimeoutMillis() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
The connection timeout.
- getCountry() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the country property for the user, if set.
- getCustomAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
Returns an enumeration of all custom attribute names that were set for this user.
- 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.
- getEmail() - Method in class com.launchdarkly.sdk.LDUser
-
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.
- getErrorKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
An enumeration value indicating the general category of error, if the
kind
isEvaluationReason.Kind.PREREQUISITE_FAILED
. - getEventsBaseUri() - Method in class com.launchdarkly.sdk.android.subsystems.ServiceEndpoints
-
The base URI for the events service.
- getEventsCapacity() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual event-related properties are removed from the top-level configuration.
- getEventsFlushIntervalMillis() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual event-related properties are removed from the top-level configuration.
- getEventsUri() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual base URI properties are removed from the top-level configuration.
- 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
- getFilteredEventGson() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.Direct access to this object is deprecated and will be removed in the future.
- getFirstName() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the first name property for the user, if set.
- getForMobileKey(String) - Static method in class com.launchdarkly.sdk.android.LDClient
- getHeaderTransform() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual HTTP-related properties are removed from the top-level configuration.
- 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.
- getInitialReconnectDelayMillis() - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Returns the configured initial stream reconnect delay.
- getIp() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the IP property for the user, if set.
- getKey() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the user's unique key.
- getKind() - Method in class com.launchdarkly.sdk.EvaluationReason
-
Returns an enum indicating the general category of the reason.
- 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
-
Returns the value of the last name property for the user, if set.
- getLastSuccessfulConnection() - Method in interface com.launchdarkly.sdk.android.ConnectionInformation
- 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
- getName() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the full name property for the user, if set.
- getName() - Method in class com.launchdarkly.sdk.UserAttribute
-
Returns the case-sensitive attribute name.
- getPollingBaseUri() - Method in class com.launchdarkly.sdk.android.subsystems.ServiceEndpoints
-
The base URI for the polling service.
- getPollingIntervalMillis() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual data source properties are removed from the top-level configuration.
- getPollIntervalMillis() - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Returns the configured foreground polling interval.
- getPollUri() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual base URI properties are removed from the top-level configuration.
- 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
. - getPrivateAttributes() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual event-related properties are removed from the top-level configuration.
- getPrivateAttributes() - Method in class com.launchdarkly.sdk.LDUser
-
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
. - getSecondary() - Method in class com.launchdarkly.sdk.LDUser
-
Returns the value of the secondary key property for the user, if set.
- 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.subsystems.ServiceEndpoints
-
The base URI for the streaming service.
- getStreamUri() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual base URI properties are removed from the top-level configuration.
- 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.
- 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.EvaluationDetail
- hashCode() - Method in class com.launchdarkly.sdk.EvaluationReason
- hashCode() - Method in class com.launchdarkly.sdk.LDUser
- hashCode() - Method in class com.launchdarkly.sdk.LDValue
- hashCode() - Method in class com.launchdarkly.sdk.UserAttribute
- headerTransform - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
- headerTransform(LDHeaderUpdater) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Provides a callback for dynamically modifying headers used on requests to LaunchDarkly services.
- headerTransform(LDHeaderUpdater) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- 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
- identify(LDUser) - Method in class com.launchdarkly.sdk.android.LDClient
- identify(LDUser) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Sets the current user, retrieves flags for that user, then sends an Identify Event to LaunchDarkly.
- init(Application, LDConfig, LDUser) - Static method in class com.launchdarkly.sdk.android.LDClient
-
Initializes the singleton/primary instance.
- init(Application, LDConfig, LDUser, 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. - initialReconnectDelayMillis - Variable in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
- initialReconnectDelayMillis(int) - Method in class com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder
-
Sets the initial reconnect delay for the streaming connection.
- inlineUsers - Variable in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
- inlineUsers(boolean) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
If enabled, events to the server will be created containing the entire LDUser object.
- inlineUsersInEvents() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual event-related properties are removed from the top-level configuration.
- inlineUsersInEvents(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- 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 flag value for the current user.
- intVariationDetail(String, int) - Method in class com.launchdarkly.sdk.android.LDClient
- intVariationDetail(String, int) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the flag value for the current user, along with information about how it was calculated.
- INVALID_RESPONSE_BODY - com.launchdarkly.sdk.android.LDFailure.FailureType
- ip(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the IP for a user.
- IP - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the IP address attribute.
- isAnonymous() - Method in class com.launchdarkly.sdk.LDUser
-
Returns true if this user was marked anonymous.
- isAttributePrivate(UserAttribute) - Method in class com.launchdarkly.sdk.LDUser
-
Tests whether an attribute has been marked private for this user.
- isBuiltIn() - Method in class com.launchdarkly.sdk.UserAttribute
-
Returns true for a built-in attribute or false for a custom attribute.
- 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.
- 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.
- isInitiallySetOffline() - Method in class com.launchdarkly.sdk.android.subsystems.ClientContext
-
Returns true if the initial configuration specified that the SDK should be offline.
- isInt() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a number that is also an integer.
- 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
- isStream() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual data source properties are removed from the top-level configuration.
- isStreamingDisabled() - Method in interface com.launchdarkly.sdk.android.subsystems.DataSource
-
Returns true if streaming is disabled.
- isString() - Method in class com.launchdarkly.sdk.LDValue
-
Tests whether this value is a string.
- isUseReport() - Method in class com.launchdarkly.sdk.android.LDConfig
-
Deprecated.This method will be removed in the future when individual HTTP-related properties are removed from the top-level configuration.
- isUseReport() - Method in class com.launchdarkly.sdk.android.subsystems.HttpConfiguration
-
The setting for whether to use the HTTP REPORT method.
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 flag value for the current user.
- jsonValueVariationDetail(String, LDValue) - Method in class com.launchdarkly.sdk.android.LDClient
- jsonValueVariationDetail(String, LDValue) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the flag value for the current user, along with information about how it was calculated.
K
- key(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Changes the user's key.
- KEY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the user key attribute.
- keys() - Method in class com.launchdarkly.sdk.LDValue
-
Enumerates the property names in an object.
L
- LAST_NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the last name attribute.
- lastName(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
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(Application, LDConfig) - Constructor for class com.launchdarkly.sdk.android.LDClient
- LDClient(Application, LDConfig, 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
- LDFailure - Exception in com.launchdarkly.sdk.android
- 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 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
- 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.
- LDStatusListener - Interface in com.launchdarkly.sdk.android
- 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
-
A collection of attributes that can affect flag evaluation, usually corresponding to a user of your application.
- LDUser(LDUser.Builder) - Constructor for class com.launchdarkly.sdk.LDUser
- LDUser(String) - Constructor for class com.launchdarkly.sdk.LDUser
-
Create a user with the given key
- LDUser.Builder - Class in com.launchdarkly.sdk
- 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 in com.launchdarkly.sdk
-
Describes the type of an
LDValue
. - 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 - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that there was an internal inconsistency in the flag data, e.g.
- maxCachedUsers(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Sets the maximum number of users 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.
- 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
.
N
- name(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the user's full name.
- NAME - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the full name attribute.
- NETWORK_FAILURE - com.launchdarkly.sdk.android.LDFailure.FailureType
- 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.
- normalize(LDValue) - Static method in class com.launchdarkly.sdk.LDValue
-
Returns the same value if non-null, or
LDValue.ofNull()
if null. - NULL - com.launchdarkly.sdk.LDValueType
-
The value is null.
- NUMBER - com.launchdarkly.sdk.LDValueType
-
The value is numeric.
O
- OBJECT - 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.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 - 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 - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- 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 user.
- onConnectionModeChanged(ConnectionInformation) - Method in interface com.launchdarkly.sdk.android.LDStatusListener
- 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 user.
- onInternalFailure(LDFailure) - Method in interface com.launchdarkly.sdk.android.LDStatusListener
- onReceive(Context, Intent) - Method in class com.launchdarkly.sdk.android.ConnectivityReceiver
- onReceive(Context, Intent) - Method in class com.launchdarkly.sdk.android.PollingUpdater
P
- parse(String) - Static method in class com.launchdarkly.sdk.LDValue
-
Parses an LDValue from a JSON representation.
- polling(Uri) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.polling(URI)
, specifying the URI as anandroid.net.Uri
. - 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 - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- pollingBaseUri - Variable in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
- 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
- pollingIntervalMillis(int) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- PollingUpdater - Class in com.launchdarkly.sdk.android
-
Used internally by the SDK.
- PollingUpdater() - Constructor for class com.launchdarkly.sdk.android.PollingUpdater
- pollIntervalMillis - Variable in class com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder
- 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.
- pollUri(Uri) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- PREREQUISITE_FAILED - 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
- privateAttributes(UserAttribute...) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Marks a set of attribute names or subproperties as private.
- privateAttributes(UserAttribute...) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- privateAttributes(String...) - Method in class com.launchdarkly.sdk.android.integrations.EventProcessorBuilder
-
Marks a set of attribute names or subproperties as private.
- privateAvatar(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
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
-
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
-
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
-
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
-
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
-
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
-
Add a
String
-valued custom attribute that will not be sent back to LaunchDarkly. - privateEmail(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
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
-
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
-
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
-
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
-
Sets the user's full name, and ensures that the name attribute will not be sent back to LaunchDarkly.
- privateSecondary(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the secondary key for a user, and ensures that the secondary key attribute is not 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
- recordAliasEvent(LDUser, LDUser) - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Creates an alias event, as when the SDK's
alias
method is called. - recordCustomEvent(LDUser, 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(LDUser, 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(LDUser) - 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(Uri) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.relayProxy(URI)
, specifying the URI as anandroid.net.Uri
. - 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 - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the user 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
- secondary(String) - Method in class com.launchdarkly.sdk.LDUser.Builder
-
Sets the secondary key for a user.
- SECONDARY_KEY - Static variable in class com.launchdarkly.sdk.UserAttribute
-
Represents the secondary key attribute.
- 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(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.subsystems
-
Specifies the base service URIs used by SDK components.
- ServiceEndpoints(URI, URI, URI) - Constructor for class com.launchdarkly.sdk.android.subsystems.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_OFFLINE - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- 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.
- SHUTDOWN - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- size() - Method in class com.launchdarkly.sdk.LDValue
-
Returns the number of elements in an array or object.
- start() - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Starts any periodic tasks used by the event processor.
- stop() - Method in interface com.launchdarkly.sdk.android.subsystems.EventProcessor
-
Stops any periodic tasks used by the event processor.
- stream(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.Use
LDConfig.Builder.dataSource(ComponentConfigurer)
with eitherComponents.streamingDataSource()
orComponents.pollingDataSource()
instead. - streaming(Uri) - Method in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
-
Equivalent to
ServiceEndpointsBuilder.streaming(URI)
, specifying the URI as anandroid.net.Uri
. - 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 - com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
- streamingBaseUri - Variable in class com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder
- 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
- streamUri(Uri) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- String - Static variable in class com.launchdarkly.sdk.LDValue.Convert
-
A
LDValue.Converter
for strings. - STRING - 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 flag value for the current user.
- stringVariationDetail(String, String) - Method in class com.launchdarkly.sdk.android.LDClient
- stringVariationDetail(String, String) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Returns the flag value for the current user, along with information about how it was calculated.
T
- TARGET_MATCH - com.launchdarkly.sdk.EvaluationReason.Kind
-
Indicates that the user 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
. - toJsonString() - Method in class com.launchdarkly.sdk.LDValue
-
Converts this value to its JSON serialization.
- 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.LDUser
- toString() - Method in class com.launchdarkly.sdk.LDValue
-
Returns a string representation of this value.
- toString() - Method in class com.launchdarkly.sdk.UserAttribute
- 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 a user performed an event.
- trackData(String, LDValue) - Method in class com.launchdarkly.sdk.android.LDClient
- trackData(String, LDValue) - Method in interface com.launchdarkly.sdk.android.LDClientInterface
-
Tracks that a user performed an event, 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 a user performed an event, and provides an additional numeric value for custom metrics.
- 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 - com.launchdarkly.sdk.android.LDFailure.FailureType
- UNEXPECTED_STREAM_ELEMENT_TYPE - com.launchdarkly.sdk.android.LDFailure.FailureType
- UNKNOWN_ERROR - com.launchdarkly.sdk.android.LDFailure.FailureType
- 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. - updateHeaders(Map<String, String>) - Method in interface com.launchdarkly.sdk.android.LDHeaderUpdater
-
An application provided method for dynamic configuration of HTTP headers.
- USER_NOT_SPECIFIED - 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
-
Represents a built-in or custom attribute name supported by
LDUser
. - useReport - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
- useReport(boolean) - Method in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
-
Sets whether to use the HTTP REPORT method for feature flag requests.
- useReport(boolean) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
V
- 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 com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.android.LDFailure.FailureType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.launchdarkly.sdk.LDValueType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.launchdarkly.sdk.android.ConnectionInformation.ConnectionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.launchdarkly.sdk.android.LDFailure.FailureType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.launchdarkly.sdk.EvaluationReason.Kind
-
Returns an array containing the constants of this enum type, 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 com.launchdarkly.sdk.LDValueType
-
Returns an array containing the constants of this enum type, 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
.
W
- 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
- wrapperName(String) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- wrapperVersion - Variable in class com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder
- wrapperVersion(String) - Method in class com.launchdarkly.sdk.android.LDConfig.Builder
-
Deprecated.
- WRONG_TYPE - com.launchdarkly.sdk.EvaluationReason.ErrorKind
-
Indicates that the result value was not of the requested type, e.g.
All Classes All Packages