This repository has been archived by the owner on Oct 29, 2024. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[7.0.0] - 2023-02-23
The latest version of this SDK supports LaunchDarkly's new custom contexts feature. Contexts are an evolution of a previously-existing concept, "users." Contexts let you create targeting rules for feature flags based on a variety of different information, including attributes pertaining to users, organizations, devices, and more. You can even combine contexts to create "multi-contexts."
This feature is only available to members of LaunchDarkly's Early Access Program (EAP). If you're in the EAP, you can use contexts by updating your SDK to the latest version and, if applicable, updating your Relay Proxy. Outdated SDK versions do not support contexts, and will cause unpredictable flag evaluation behavior.
If you are not in the EAP, only use single contexts of kind "user", or continue to use the user type if available. If you try to create contexts, the context will be sent to LaunchDarkly, but any data not related to the user object will be ignored.
For detailed information about this version, please refer to the list below. For information on how to upgrade from the previous version, please read the migration guide.
Added:
LDContext
,LDSingleKindContext
, andLDMultiKindContext
define the new "context" model.Changed:
LDConfig
changes to be consistent with the Javascript SDK:pollUri
,streamUri
,eventsUri
are nowpollUrl
,streamUrl
andeventsUrl
.eventsCapacity
is noweventCapacity
eventsFlushIntervalMillis
,connectionTimeoutMillis
,pollingIntervalMillis
,backgroundPollingIntervalMillis
are nowflushInterval
,connectionTimeout
,pollingInterval
,backgroundPollingInterval
.diagnosticRecordingIntervalMillis
is nowdiagnosticRecordingInterval
maxCachedUsers
is nowmaxCachedContexts
allUserAttributesPrivate
,privateAttributeNames
are nowallAttributesPrivate
andprivateAttributes
LDUser
type is now imported from the Javascript sdk common package.All SDK methods that took an
LDUser
parameter now take anLDContext
.LDUser
is now a subset ofLDContext
, so existing code based on users will still work.Removed:
secondary
meta-attribute inLDUser
.alias
method no longer exists because alias events are not needed in the new context model.autoAliasingOptOut
andinlineUsersInEvents
options no longer exist because they are not relevant in the new context model.Deprecated:
LDUser
object has been deprecated. Support forLDUser
is maintained to simplify the upgrade process, but it is recommended to useLDContext
in the shape of eitherLDSingleKindContext
orLDMultiKindContext
.