Uniform Platform API

Home > @uniformdev/context

context package

Classes

Class

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

Context

</td><td>

</td></tr> <tr><td>

CookieTransitionDataStore

</td><td>

Handles client-to-server score handoff using an encoded cookie with the visitor score vector. NOTE: forget me is not supported when on the server side.

</td></tr> <tr><td>

EdgeTransitionDataStore

</td><td>

</td></tr> <tr><td>

GroupCriteriaEvaluator

</td><td>

</td></tr> <tr><td>

ManifestInstance

</td><td>

</td></tr> <tr><td>

VisitorDataStore

</td><td>

</td></tr> </tbody></table>

Abstract Classes

Abstract Class

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

TransitionDataStore

</td><td>

</td></tr> </tbody></table>

Enumerations

Enumeration

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

ScriptType

</td><td>

</td></tr> </tbody></table>

Functions

Function

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

computeAggregateDimensions(primitiveScores, aggregates)

</td><td>

Computes aggregated scores based on other dimensions

</td></tr> <tr><td>

createConsoleLogDrain(level)

</td><td>

Creates a new log drain that will log to the console. The log drain will only log event IDs, but is much smaller than the debug log drain.

NOTE: you probably want enableConsoleLogDrain() instead of this function.

</td></tr> <tr><td>

createDebugConsoleLogDrain(level, options)

</td><td>

Creates a new log drain that will log full debug messages to the console. The debug log drain adds significant bundle size, but is useful for debugging.

NOTE: you probably want enableDebugConsoleLogDrain() instead of this function.

</td></tr> <tr><td>

createLinearDecay(options)

</td><td>

Creates a function that applies linear decay to scores over time.

</td></tr> <tr><td>

enableConsoleLogDrain(level)

</td><td>

Enables logging Context events to the browser console. Lightweight events with only the event ID are emitted.

</td></tr> <tr><td>

enableContextDevTools(options)

</td><td>

Enables a Context instance to feed data to the Uniform Context DevTools. DevTools can be hosted either as a Chromium extension, or as a standalone React app within a page and receive data once this plugin has been activated.

</td></tr> <tr><td>

enableDebugConsoleLogDrain(level, options)

</td><td>

Enables logging Context events to the browser console. Lightweight events with only the event ID are emitted.

</td></tr> <tr><td>

evaluateVariantMatch(variantId, match, vec, onLogMessage)

</td><td>

</td></tr> <tr><td>

explainStringMatch(lhs, match)

</td><td>

</td></tr> <tr><td>

explainStringMatchCriteria(match)

</td><td>

</td></tr> <tr><td>

getEnrichmentVectorKey(category, value)

</td><td>

</td></tr> <tr><td>

isStringMatch(lhs, match)

</td><td>

Tests if a StringMatch matches a string value

</td></tr> <tr><td>

parseQuickConnect(serialized)

</td><td>

</td></tr> <tr><td>

personalizeVariations({ name, context, variations, take, onLogMessage, })

</td><td>

</td></tr> <tr><td>

serializeQuickConnect(config)

</td><td>

</td></tr> </tbody></table>

Interfaces

Interface

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

ContextInstance

</td><td>

</td></tr> </tbody></table>

Variables

Variable

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

CONTEXTUAL_EDITING_TEST_NAME

</td><td>

</td></tr> <tr><td>

CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID

</td><td>

</td></tr> <tr><td>

cookieEvaluator

</td><td>

</td></tr> <tr><td>

currentPageEvaluator

</td><td>

</td></tr> <tr><td>

EdgeNodeTagName

</td><td>

</td></tr> <tr><td>

emptyVisitorData

</td><td>

</td></tr> <tr><td>

eventEvaluator

</td><td>

</td></tr> <tr><td>

pageViewCountDimension

</td><td>

</td></tr> <tr><td>

pageViewCountEvaluator

</td><td>

</td></tr> <tr><td>

queryStringEvaluator

</td><td>

</td></tr> <tr><td>

quirkEvaluator

</td><td>

</td></tr> <tr><td>

SERVER_STATE_ID

</td><td>

</td></tr> <tr><td>

testVariations

</td><td>

</td></tr> <tr><td>

UNIFORM_DEFAULT_COOKIE_NAME

</td><td>

</td></tr> </tbody></table>

Type Aliases

Type Alias

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

AggregateDimension

</td><td>

</td></tr> <tr><td>

AggregateDimensionInput

</td><td>

</td></tr> <tr><td>

BehaviorTag

</td><td>

Content that is tagged for adding enrichment score when triggered by behavior (i.e. being shown that content)

</td></tr> <tr><td>

ConsoleDebugLogDrainOptions

</td><td>

</td></tr> <tr><td>

ContextDevToolOptions

</td><td>

</td></tr> <tr><td>

ContextEvents

</td><td>

</td></tr> <tr><td>

ContextOptions

</td><td>

</td></tr> <tr><td>

ContextPlugin

</td><td>

Defines a plugin for Uniform Context. The plugin should attach event handlers in its creation function.

</td></tr> <tr><td>

ContextState

</td><td>

Expresses a 'patch' to the Uniform Context state

</td></tr> <tr><td>

ContextStateUpdate

</td><td>

</td></tr> <tr><td>

CookieTransitionDataStoreOptions

</td><td>

</td></tr> <tr><td>

CriteriaEvaluator

</td><td>

A type that evaluates a signal criteria type and decides if it matches the current Context state or not.

</td></tr> <tr><td>

CriteriaEvaluatorParameters

</td><td>

</td></tr> <tr><td>

CriteriaEvaluatorResult

</td><td>

The result of evaluating a signal criteria.

</td></tr> <tr><td>

DecayFunction

</td><td>

Computes decay of visitor scores over time. NOTE: it is expected that this function mutates the incoming score vectors, if it needs to apply score decay. The data store ensures immutability already.

</td></tr> <tr><td>

DecayOptions

</td><td>

</td></tr> <tr><td>

DevToolsActions

</td><td>

Mutations the DevTools can take on the data it receives

</td></tr> <tr><td>

DevToolsDataEvent

</td><td>

Emitted when data is updated in Context to the devtools

</td></tr> <tr><td>

DevToolsEvent

</td><td>

</td></tr> <tr><td>

DevToolsEvents

</td><td>

</td></tr> <tr><td>

DevToolsForgetEvent

</td><td>

A request to forget me from the DevTools

</td></tr> <tr><td>

DevToolsHelloEvent

</td><td>

A hello message emitted as an event from the browser extension to test if the page contains Context

</td></tr> <tr><td>

DevToolsLogEvent

</td><td>

A log message emitted as an event to the browser extension

</td></tr> <tr><td>

DevToolsRawCommandsEvent

</td><td>

Devtools requests a raw update cycle (explicitly set scores of dimensions in durations, etc)

</td></tr> <tr><td>

DevToolsState

</td><td>

The data state provided to the devtools for rendering.

</td></tr> <tr><td>

DevToolsUiVersion

</td><td>

The version of the DevTools UI to load when in Chromium extension context. 1: Uniform Optimize. 2: Uniform Context.

</td></tr> <tr><td>

DevToolsUpdateEvent

</td><td>

Devtools requests a normal update cycle (regular data update, re-eval signals, etc)

</td></tr> <tr><td>

DimensionMatch

</td><td>

</td></tr> <tr><td>

EdgePersonalizeComponentOptions

</td><td>

</td></tr> <tr><td>

EdgeTestComponentOptions

</td><td>

</td></tr> <tr><td>

EdgeTransitionDataStoreOptions

</td><td>

</td></tr> <tr><td>

EnrichmentCategory

</td><td>

</td></tr> <tr><td>

EnrichmentData

</td><td>

</td></tr> <tr><td>

EventData

</td><td>

An event that has occurred (i.e. an analytics track) which may trigger an Event signal

</td></tr> <tr><td>

IdentifyCommand

</td><td>

Identifies the visitor as being a specific unique identifier. NOTE: this only has an effect when using an external cross-device transition storage system. NOTE: you cannot read the identified visitor ID back from the storage system once it is set.

</td></tr> <tr><td>

LinearDecayOptions

</td><td>

</td></tr> <tr><td>

LogDrain

</td><td>

</td></tr> <tr><td>

LogMessage

</td><td>

</td></tr> <tr><td>

LogMessageGroup

</td><td>

</td></tr> <tr><td>

LogMessages

</td><td>

Defines all error codes and their parameter(s)

</td></tr> <tr><td>

LogMessageSingle

</td><td>

</td></tr> <tr><td>

ManifestV2

</td><td>

</td></tr> <tr><td>

MessageCategory

</td><td>

</td></tr> <tr><td>

MessageFunc

</td><td>

</td></tr> <tr><td>

ModifyScoreCommand

</td><td>

Changes the visitor's permanent score for a given dimension

</td></tr> <tr><td>

ModifySessionScoreCommand

</td><td>

Changes the visitor's session (time-based) score for a given dimension

</td></tr> <tr><td>

NumberMatch

</td><td>

</td></tr> <tr><td>

OutputSeverity

</td><td>

</td></tr> <tr><td>

PersonalizationEvent

</td><td>

Emitted when a personalization runs

</td></tr> <tr><td>

PersonalizationManifest

</td><td>

</td></tr> <tr><td>

PersonalizeControlVariant

</td><td>

</td></tr> <tr><td>

PersonalizedResult

</td><td>

The result of computing personalized content from variations

</td></tr> <tr><td>

PersonalizedVariant

</td><td>

Defines the shape of a personalized content variant

</td></tr> <tr><td>

PersonalizeOptions

</td><td>

</td></tr> <tr><td>

PersonalizeVariants

</td><td>

</td></tr> <tr><td>

QuickConnectConfig

</td><td>

</td></tr> <tr><td>

Quirks

</td><td>

</td></tr> <tr><td>

ScoreVector

</td><td>

</td></tr> <tr><td>

ServerToClientTransitionState

</td><td>

</td></tr> <tr><td>

SetConsentCommand

</td><td>

Changes the visitor's storage consent setting. Setting consent to false will trigger deletion of any stored data for the visitor. Scores are still collected in-memory when consent is false; just not persisted.

</td></tr> <tr><td>

SetControlGroupCommand

</td><td>

Sets whether the current visitor is in the personalization control group (Will not be exposed to personalization or gather classification data; WILL see A/B tests) In most cases this should not be sent as the membership is computed automatically for visitors; this command is intended mostly for diagnostics and testing purposes.

</td></tr> <tr><td>

SetPersonalizeVariantControlCommand

</td><td>

</td></tr> <tr><td>

SetQuirkCommand

</td><td>

Sets a permanent quirk key and value for the visitor

</td></tr> <tr><td>

SetTestCommand

</td><td>

Sets a specific variant as being this visitor's variant on an A/B test

</td></tr> <tr><td>