setUserAttributes()

Stores structured attributes for the current user to power offer targeting, personalization, and analytics. Attributes are merged with the ones already stored; they do not replace them.

Signature

Future<void> setUserAttributes(EncoreUserAttributes attributes)

The Future completes once the call reaches the native SDK. It does not wait for the network.

Parameters

Name	Type	Description
`attributes`	`EncoreUserAttributes`	The attributes to merge. See EncoreUserAttributes for every field

Merge rules

Attributes are merged, not replaced. If you set email and subscriptionTier, then later set monthsSubscribed, all three are kept.

A field you leave null is unchanged. Passing only language updates language and nothing else.
custom merges key by key. A key you send overwrites the stored value for that key; keys you don’t send are kept.
You can’t clear a single field. null means “leave as is”. To clear everything, call reset().
An empty EncoreUserAttributes() does nothing.

identify() behaves differently: attributes passed there replace the stored set.

Usage

Basic attributes

await Encore.shared.setUserAttributes(
  EncoreUserAttributes(
    email: 'user@example.com',
    subscriptionTier: 'premium',
    monthsSubscribed: '6',
  ),
);

Custom attributes

await Encore.shared.setUserAttributes(
  EncoreUserAttributes(custom: {'cancelReason': 'too_expensive'}),
);

Location and language

await Encore.shared.setUserAttributes(
  EncoreUserAttributes(countryCode: 'US', language: 'en'),
);

Call setUserAttributes() after configure(). Attributes set before the SDK is configured are not stored.

EncoreUserAttributes: every field, its format, and an example value
identify(): sets a user ID and attributes in one call

iOS

Android

Web

Bridges

setUserAttributes()

Signature

Parameters

Merge rules

Usage

Basic attributes

Custom attributes

Location and language

​Signature

​Parameters

​Merge rules

​Usage

​Basic attributes

​Custom attributes

​Location and language

​Related

Signature

Parameters

Merge rules

Usage

Basic attributes

Custom attributes

Location and language

Related