Interface LDOverrideSinkExperimental

Receives the contents of the SDK's flag and segment override layer. The SDK implements this interface and passes it to LDOverrideSource.start. Override sources call it. They do not implement it.

Flag overrides are currently experimental and subject to change.

Hierarchy

  • LDOverrideSink

Methods

Methods

  • Replaces the entire override layer with the given flag and segment definitions. Each call is a full snapshot. Entries absent from the call are removed from the layer, and empty arrays clear the layer.

    The definitions are plain objects in the flag and segment data model, in the form in which LaunchDarkly delivers them. The SDK copies them, prepares the copies for evaluation, and marks the copies as override entries. It never modifies the objects it was given. A definition that does not have the shape the SDK requires, for example a flag without a variations array, is rejected with an error that names the kind, the key, and the field, and no part of the snapshot is applied: the layer keeps its previous contents.

    The new contents are visible to evaluations when the call returns. Flag change notifications for the affected flags follow.

    Parameters

    Returns void

Generated using TypeDoc