Anonymous contexts

To distinguish logged-in end users from anonymous end users in the SDK:

1
Context context = Context.Builder("context-key-123abc")
2
    .Anonymous(true)
3
    .Build();

To auto-generate a key for any context whose anonymous attribute is true:

1
var config = Configuration
2
    .Builder("mobile-key-123abc", ConfigurationBuilder.AutoEnvAttributes.Enabled)
3
    .GenerateAnonymousKeys(true)
4
    .Build();

If you set this option, you must still specify a non-null key as a placeholder when you construct the Context, because the SDK does not allow a Context to exist with a null key. When you pass this context to SDK methods like Init or Identify, the SDK replaces the placeholder key with a generated key.

In this example, the placeholder key is “placeholder-key”, but it could be any non-empty string:

1
Context context = Context.Builder("placeholder-key")
2
    .Anonymous(true)
3
    .Build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
LDContext context = LDContext.builder("context-key-123abc")
2
    .anonymous(true)
3
    .build();

If you set this option, you must still specify a non-null key as a placeholder when you construct the LDContext, because this SDK does not allow a Context to exist with a null key. When you pass this context to SDK methods like Init or Identify, the SDK replaces the placeholder key with a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots.

To distinguish logged-in end users from anonymous end users in the SDK:

1
auto context = ContextBuilder()
2
  .Kind("user", "user-key-123abc")
3
  .Anonymous(true)
4
  .Build();

To learn more, read ContextBuilder.

To distinguish logged-in end users from anonymous end users in the SDK:

1
const anonymousUser = { key: 'user-key-123abc', anonymous: true };

To create an anonymous user with an auto-generated key, specify the “anonymous” property and omit the “key” property. The LaunchDarkly client creates a unique key for this user and caches it locally:

1
const anonymousUser = { anonymous: true };

To distinguish logged-in end users from anonymous end users in the SDK:

1
final context = LDContextBuilder()
2
  .kind('user', 'user-key-123abc')
3
  .anonymous(true)
4
  .build();

To learn more, read anonymous.

To distinguish logged-in end users from anonymous end users in the SDK:

1
var contextBuilder = LDContextBuilder(key: "context-key-123abc")
2
contextBuilder.anonymous(true)
3
4
let context = contextBuilder.build().get()

Alternatively, you can omit the key parameter. The client will automatically set the isAnonymous property for the context, and set the key to a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots.

Here’s how:

1
// Have the SDK use a device persistent key.
2
// This sets `isAnonymous` by default.
3
let context = try LDContextBuilder().build().get()

To create an anonymous context, specify the anonymous property and omit the key property. The client will automatically set the key to a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots.

Here’s how:

1
const anonymousUserContext = {
2
  kind: 'user',
3
  anonymous: true
4
};
5
6
// A multi-context can contain both anonymous and non-anonymous contexts.
7
// Here, the organization is not anonymous.
8
const multiContext = {
9
  kind: 'multi',
10
  user: anonymousUserContext,
11
  org: {
12
    key: 'org-key-123abc',
13
    name: 'Acme, Inc.'
14
  }
15
}

To distinguish logged-in end users from anonymous end users in the SDK:

1
const anonymousContext = { kind: 'user', key: 'user-key-123abc', anonymous: true };

You can also have the SDK generate the key for you. Specify the anonymous property and omit the key property. The client will automatically set the key to a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots.

Here’s how:

1
const anonymousContext = { kind: 'user', anonymous: true };

To create an create an anonymous context, specify the anonymous property and set the context key to an empty string.

Here’s how:

1
// This device context is anonymous
2
const deviceContext = {
3
  // The key attribute is required and should be empty
4
  // The SDK will automatically generate a unique, stable key
5
  key: '',
6
  kind: 'device',
7
  deviceId: '12345',
8
  anonymous: true
9
}
10
11
// This user context is not anonymous
12
const userContext = {
13
  kind: 'user',
14
  key: 'user-key-123abc'
15
}
16
17
// The multi-context contains one anonymous context
18
// and one non-anonymous context
19
const multiContext = {
20
  kind: 'multi',
21
  user: userContext,
22
  device: deviceContext
23
}

In version 10 of the SDK, you must include the key attribute when building the anonymous context. If you set the key to an empty string, the client will automatically set the key to a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots. We strongly recommend having the client manage the key for anonymous contexts. If you set the key to a non-empty string, the client uses that value as the key. However, the key may not be stable across restarts or reboots.

The SDK gives a usage error if you omit the key attribute. It also gives a usage error if you set the key to an empty string and do not mark the context as anonymous.

In versions 7 through 9 of the SDK, you may omit the context key when building an anonymous context, and the client will automatically set it to a LaunchDarkly-specific, device-unique string that is consistent between app restarts and device reboots.

Using a shared key between anonymous contexts in React Native for Android

It is possible to use one, shared key between anonymous contexts. However, we do not recommend this. Using a shared key between anonymous contexts means that some features will be limited or will not work as expected. To learn more, read Use a shared key between anonymous contexts.

If you are using an older version of the React Native SDK on Android, there is some additional configuration required if you want to use a shared key between anonymous contexts.

1
import LDClient, { LDConfig } from 'launchdarkly-react-native-client-sdk';
2
3
let config: LDConfig = {
4
  mobileKey: 'mobile-key-123abc',
5
  enableAutoEnvAttributes: true,
6
  generateAnonymousKeysAndroid: false
7
};
8
9
let context: LDContext = {
10
  kind: 'user',
11
  key: 'shared-key-for-anonymous-users',
12
  anonymous: true
13
}
14
15
await client.configure(config, context);

To distinguish logged-in end users from anonymous end users in the SDK:

1
context = LaunchDarklyCreateContext({"key": "user-key-123abc", "kind": "user", "anonymous": true})

To distinguish logged-in end users from anonymous end users in the SDK:

1
var context = Context.Builder("context-key-123abc")
2
    .Anonymous(true)
3
    .Build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
LDUser user = new LDUser.Builder('abc123')
2
    .setAnonymous(true)
3
    .build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
auto context = ContextBuilder()
2
  .Kind("user", "user-key-123abc")
3
  .Anonymous(true)
4
  .Build();

To learn more, read ContextBuilder.

To distinguish logged-in end users from anonymous end users in the SDK:

1
    Context = ldclient_context:set(anonymous, true,
2
        ldclient_context:new(<<"user-key-123abc">>))

To distinguish logged-in end users from anonymous end users in the SDK:

1
import (
2
    "github.com/launchdarkly/go-sdk-common/v3/ldcontext"
3
)
4
5
// Anonymous context with only a key
6
context1 := ldcontext.NewBuilder("context-key-123abc").Anonymous(true)
7
8
// Anonymous context with a key plus other attributes
9
context2 := ldcontext.NewBuilder("context-key-456def").
10
    Anonymous(true).
11
    SetString("country", "Canada").
12
    Build()

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read EventsConfiguration.

To distinguish logged-in end users from anonymous end users in the SDK:

1
makeContext "user-key-123abc" "user"
2
  & withAnonymous True

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read configSetOmitAnonymousContexts.

To distinguish logged-in end users from anonymous end users in the SDK:

1
LDContext context = LDContext.builder("context-key-123abc")
2
  .anonymous(true)
3
  .build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
-- to create an anonymous user context
2
local userContext = ld.makeContext({
3
    user = {
4
      key       = "user-key-123abc",
5
      anonymous = true
6
    }
7
})
8
9
-- to create an anonymous context of a different kind
10
local deviceContext = ld.makeContext({
11
    device    = {
12
      key       = "device-key-123abc",
13
      anonymous = true
14
    }
15
})

To learn more, read makeContext.

To distinguish logged-in end users from anonymous end users in the SDK:

1
import * as ld from '@launchdarkly/node-server-sdk';
2
3
const context: ld.LDContext = {
4
  kind: 'user',
5
  key: 'user-key-123abc',
6
  anonymous: true,
7
}

To distinguish logged-in end users from anonymous end users in the SDK:

1
$context = LDContext::builder("context-key-123abc")->anonymous(true)->build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
context = Context.builder("context-key-123abc").anonymous(True).build()

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read omit_anonymous_contexts.

To distinguish logged-in end users from anonymous end users in the SDK:

1
context = { key: "context-key-123abc", anonymous: true }

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read omit_anonymous_contexts.

To distinguish logged-in end users from anonymous end users in the SDK:

1
// Anonymous context with only a key
2
let context = ContextBuilder::new("context-key-123abc").anonymous(true).build();
3
4
// Anonymous context with a key plus other attributes
5
let context = ContextBuilder::new("context-key-123abc").
6
    anonymous(true).
7
    set_value("country", "US".into()).
8
    build();

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read omit_anonymous_contexts.

To distinguish logged-in end users from anonymous end users in the SDK:

1
import { LDContext } from '@launchdarkly/akamai-edgeworker-sdk-common';
2
3
const anonymousContext: LDContext = { kind: 'user', key: 'user-key-123abc', anonymous: true };

To distinguish logged-in end users from anonymous end users in the SDK:

1
import type { LDContext } from '@launchdarkly/cloudflare-server-sdk';
2
3
const anonymousContext: LDContext = { kind: 'user', key: 'user-key-123abc', anonymous: true };

To distinguish logged-in end users from anonymous end users in the SDK:

1
import type { LDContext } from '@launchdarkly/vercel-server-sdk';
2
3
const anonymousContext: LDContext = { kind: 'user', key: 'user-key-123abc', anonymous: true };

To distinguish logged-in end users from anonymous end users in the SDK:

1
var context = Context.Builder("context-key-123abc")
2
    .Anonymous(true)
3
    .Build();

To distinguish logged-in end users from anonymous end users in the SDK:

1
import (
2
    "github.com/launchdarkly/go-sdk-common/v3/ldcontext"
3
)
4
5
// Anonymous context with only a key
6
context1 := ldcontext.NewBuilder("context-key-123abc").Anonymous(true)
7
8
// Anonymous context with a key plus other attributes
9
context2 := ldcontext.NewBuilder("context-key-456def").
10
    Anonymous(true).
11
    SetString("country", "Canada").
12
    Build()

To distinguish logged-in end users from anonymous end users in the SDK:

1
const context: LDContext = {
2
  kind: 'user',
3
  key: 'user-key-123abc',
4
  anonymous: true,
5
}

Anonymous contexts do not appear on the Contexts list.

To distinguish logged-in end users from anonymous end users in the SDK:

1
context = Context.builder("context-key-123abc").anonymous(True).build()

Anonymous contexts do not appear on the Contexts list. Optionally, you can configure the SDK to omit data from anonymous contexts when sending related events to LaunchDarkly. Depending on how your application uses contexts, this can significantly decrease the amount of data your application sends to LaunchDarkly. To learn more, read omit_anonymous_contexts.