identify() - Encore

Links your user ID to the SDK’s anonymous ID for cross-device entitlement tracking and attribution. Call this after a successful login to sync the user’s entitlements across devices.

Signature

fun identify(
    userId: String,
    attributes: UserAttributes? = null
)

Parameters

Name	Type	Description
`userId`	String	Your user’s unique identifier from your auth system. A blank or whitespace-only value is ignored: it never persists or replaces the current identity, and the SDK logs a warning.
`attributes`	UserAttributes?	Optional structured attributes to set for the user in one call. Defaults to `null`.

Usage

Basic identification

// After successful login
Encore.shared.identify(userId = user.id)

With attributes

Encore.shared.identify(
    userId = user.id,
    attributes = UserAttributes(
        email = user.email,
        subscriptionTier = user.plan,
        monthsSubscribed = user.monthsActive.toString()
    )
)

Call identify() after a successful login. On logout, call reset() to clear the user ID and cached entitlements.

UserAttributes: the attribute fields this call accepts
setUserAttributes(): updates attributes without changing identity
reset(): clears the identity on logout