launchdarkly_flutter_client_sdk library
This is the API reference for the LaunchDarkly Client-Side SDK for Flutter.
In typical usage, you will create an LDClient instance once at startup, which provides access to all of the SDK's functionality.
A complete reference guide is available on the LaunchDarkly documentation site.
Classes
- ApplicationEvents
- Configuration which affects how the SDK responds to events affecting the application.
- ApplicationInfo
- Application metadata may be used by LaunchDarkly analytics or other product features.
- AttributeReference
- An attribute name or path expression identifying a value within an LDContext.
- CredentialSource
- Allows loading a credential, either a client-side ID or mobile key, from environment variables.
- DataSourceConfig
- DataSourceStatus
- DataSourceStatusErrorInfo
- A description of an error condition that the data source encountered.
- EventsConfig
- Configuration for event processing and sending.
- FlagsChangedEvent
- This event indicates that the details associated with one or more flags have changed.
- HttpProperties
- IdentifyComplete
- The identify has been completed. Either the identify completed with cached data, or new data was fetched from LaunchDarkly.
- IdentifyError
- The identify operation encountered an error and will not complete.
- IdentifyResult
- Base class used for all identify results. Using a sealed class allows for exhaustive matching the the return from identify operations.
- IdentifySuperseded
- The identify has been superseded. Multiple identify calls were outstanding and this one has been cancelled.
- LDAttributesBuilder
-
A builder for constructing
LDContextAttributes. - LDBasicLogPrinter
- Basic log printer which will output all messages using print.
- LDClient
- The main interface for the LaunchDarkly Flutter SDK.
- LDConfig
- LDContext
- A collection of attributes that can be referenced in flag evaluations and analytics events. A LDContext may contain information about a single context or multiple contexts differentiated by the "kind" attribute.
- LDContextBuilder
- A builder to facilitate the creation of LDContexts. Note that the return type of kind is a LDAttributesBuilder that is used to define attributes for the specific kind of context you are creating.
-
LDEvaluationDetail<
T> - Class returned by the "variation detail" methods such as LDClient.boolVariationDetail, combining the result of the evaluation with an explanation of how it was calculated.
- LDEvaluationReason
- Describes the reason that a flag evaluation produced a particular value.
- LDLogAdapter
- Interface used by log printers for use with the SDK. A custom implementation can be used to adapt the SDK log output to a logging framework of your choice.
- LDLogger
- Logging implementation used by the SDK. A default constructed logger will enable the LDLogLevel.info level and will output messages using the LDBasicLogPrinter.
- LDLogRecord
- Represents a log entry from LDLogger. It can be used with an LDLogAdapter to control logging output from the SDK.
- LDValue
- An immutable instance of any data type that is allowed in JSON.
- LDValueArrayBuilder
- Builder for constructing an LDValueType.array typed LDValue.
- LDValueObjectBuilder
- Builder for constructing an LDValueType.object typed LDValue.
- PersistenceConfig
- Configuration which affects how the SDK uses persistence.
- ServiceEndpoints
- Specifies the base service URLs used by SDK components.
Enums
- AutoEnvAttributes
- Enable / disable options for Auto Environment Attributes functionality. When enabled, the SDK will automatically provide data about the mobile environment where the application is running. This data makes it simpler to target your mobile customers based on application name or version, or on device characteristics including manufacturer, model, operating system, locale, and so on. We recommend enabling this when you configure the SDK. See https://docs.launchdarkly.com/sdk/features/environment-attributes for more documentation.
- ConnectionMode
- The connection mode for the SDK to use.
- DataSourceState
- LDErrorKind
- Enumerated type defining the defined error cases for an LDEvaluationReason with the kind LDKind.error.
- LDKind
- Enumerated type defining the possible reasons for a flag evaluation result, used in LDEvaluationReason.
- LDLogLevel
-
Logging levels that can be used with LDLogger.
Set the log level to one of these values when constructing a LDLogger
to control level of log messages are enabled.
Going from lowest importance (and most verbose) to most importance, the
levels are: LDLogLevel.debug, LDLogLevel.info, LDLogLevel.warn,
and LDLogLevel.error.
You can also specify
'none'instead to disable all logging. - LDValueType
- Describes the type of an LDValue. These correspond to the standard types in JSON.