Anonymous contexts and users

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

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

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

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

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:

Context context = Context.Builder("placeholder-key")
    .Anonymous(true)
    .Build();
COPY

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

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

When you mark the context as anonymous, you can leave the key parameter in the Builder null or make it an empty string. The client will automatically set it to 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:

auto context = ContextBuilder()
  .Kind("user", "user-key-123abc")
  .Anonymous(true)
  .Build();
COPY

To learn more, read ContextBuilder.

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

const anonymousUser2 = { key: 'user-key-123abc', anonymous: true };
COPY

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:

const anonymousUser = { anonymous: true };
COPY

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

final context = LDContextBuilder()
  .kind('user', 'user-key-123abc')
  .anonymous(true)
  .build();
COPY

To learn more, read anonymous.

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

var contextBuilder = LDContextBuilder(key: "context-key-123abc")
contextBuilder.anonymous(true)
let context = contextBuilder.build().get()
COPY

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:

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

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:

const anonymousUserContext = {
  kind: 'user',
  anonymous: true
};
// A multi-context can contain both anonymous and non-anonymous contexts.
// Here, the organization is not anonymous.
const multiContext = {
  kind: 'multi',
  user: anonymousUserContext,
  org: {
    key: 'org-key-123abc',
    name: 'Acme, Inc.'
  }
}
COPY

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

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

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:

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

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

Here's how:

// This device context is anonymous
const deviceContext = {
  // The key attribute is required and should be empty
  // The SDK will automatically generate a unique, stable key
  key: '',
  kind: 'device',
  deviceId: '12345',
  anonymous: true
}
// This user context is not anonymous
const userContext = {
  kind: 'user',
  key: 'user-key-123abc'
}
// The multi-context contains one anonymous context
// and one non-anonymous context
const multiContext = {
  kind: 'multi',
  user: userContext,
  device: deviceContext
}
COPY

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 Using 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.

import LDClient, { LDConfig } from 'launchdarkly-react-native-client-sdk';
let config: LDConfig = {
  mobileKey: 'mobile-key-123abc',
  enableAutoEnvAttributes: true,
  generateAnonymousKeysAndroid: false
};
let context: LDContext = {
  kind: 'user',
  key: 'shared-key-for-anonymous-users',
  anonymous: true
}
await client.configure(config, context);
COPY

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

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

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

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

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

LDUser user = new LDUser.Builder('abc123')
    .setAnonymous(true)
    .build();
COPY

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

auto context = ContextBuilder()
  .Kind("user", "user-key-123abc")
  .Anonymous(true)
  .Build();
COPY

To learn more, read ContextBuilder.

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

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

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

import (
    "github.com/launchdarkly/go-sdk-common/v3/ldcontext"
)
// Anonymous context with only a key
context1 := ldcontext.NewBuilder("context-key-123abc").Anonymous(true)
// Anonymous context with a key plus other attributes
context2 := ldcontext.NewBuilder("context-key-456def").
    Anonymous(true).
    SetString("country", "Canada").
    Build()
COPY

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

makeContext "user-key-123abc" "user"
  & withAnonymous True
COPY

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

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

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

-- to create an anonymous user context
local userContext = ld.makeContext({
    user = {
      key       = "user-key-123abc",
      anonymous = true
    }
})
-- to create an anonymous context of a different kind
local deviceContext = ld.makeContext({
    device    = {
      key       = "device-key-123abc",
      anonymous = true
    }
})
COPY

To learn more, read makeContext.

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

import * as ld from '@launchdarkly/node-server-sdk';
const context: ld.LDContext = {
  kind: 'user',
  key: 'user-key-123abc',
  anonymous: true,
}
COPY

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

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

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

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

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

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

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

// Anonymous context with only a key
let context = ContextBuilder::new("context-key-123abc").anonymous(true).build();
// Anonymous context with a key plus other attributes
let context = ContextBuilder::new("context-key-123abc").
    anonymous(true).
    set_value("country", "US".into()).
    build();
COPY

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

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

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

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

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

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