Remote Config

import 'package:nexus_flutter/nexus.dart';

NexusRemoteConfigCopy Anchor Link

Firebase-style Remote Config. Fetches the active template for this app instance, resolves conditional values server-side, and exposes typed getters with in-app defaults as the fallback.

nexus.remoteConfig.setDefaults({'welcome': 'Hi', 'max_items': 10});
await nexus.remoteConfig.fetch();
final msg = nexus.remoteConfig.getString('welcome');

onChangeCopy Anchor Link

Stream<void> get onChange

Emits after every fetch that changes the active values.

versionCopy Anchor Link

int get version

The active template version last fetched (0 until first fetch).

lastFetchTimeCopy Anchor Link

DateTime? get lastFetchTime

attributesCopy Anchor Link

Map<String, Object?> get attributes

The custom targeting attributes currently sent with fetches.

setDefaults()Copy Anchor Link

void setDefaults(Map<String, Object?> defaults)

Set in-app fallback values (used until the server provides a value). Merges with any existing defaults. Mirrors Firebase setDefaults.

Parameters

setAttributes()Copy Anchor Link

void setAttributes(Map<String, Object?> attributes)

Custom targeting attributes sent with every fetch (e.g. governorate, plan, segment). These feed "Custom attribute" conditions on the server. Merges with existing attributes; call clearAttributes to reset. Mirrors Firebase custom signals. Values must be string/number/bool.

Parameters

setAttribute()Copy Anchor Link

void setAttribute(String key, Object? value)

Set (or replace) a single custom targeting attribute. Pass null to remove.

Parameters

clearAttributes()Copy Anchor Link

void clearAttributes()

fetch()Copy Anchor Link

Future<bool> fetch({Map<String, Object?>? attributes})

Fetch the active template and activate it. Returns true when the values changed since the last fetch. attributes are merged (for this fetch only) over the persistent ones set via setAttributes. Best-effort — never throws.

Parameters

Returns Future<bool>

getValue()Copy Anchor Link

Object? getValue(String key)

The raw value for key (server value, else in-app default, else null).

Parameters

Returns Object?

getString()Copy Anchor Link

String getString(String key, [String fallback = ''])

Parameters

Returns String

getBool()Copy Anchor Link

bool getBool(String key, [bool fallback = false])

Parameters

Returns bool

getInt()Copy Anchor Link

int getInt(String key, [int fallback = 0])

Parameters

Returns int

getDouble()Copy Anchor Link

double getDouble(String key, [double fallback = 0])

Parameters

Returns double

getJson()Copy Anchor Link

Object? getJson(String key, [Object? fallback])

A JSON value (Map/List) for key, or fallback when absent.

Parameters

Returns Object?

sourceOf()Copy Anchor Link

String? sourceOf(String key)

The condition that supplied key's value (null when the default applied).

Parameters

Returns String?

getAll()Copy Anchor Link

Map<String, Object?> getAll()

Every currently-active key → value (server values overlaid on defaults).

Returns Map<String, Object?>

subscribeRealtime()Copy Anchor Link

Future<void> subscribeRealtime(NexusRealtime realtime)

Subscribe to server-pushed config updates: on a new publish, re-fetch. Requires an active realtime connection. Safe to call more than once.

Parameters

unsubscribeRealtime()Copy Anchor Link

Future<void> unsubscribeRealtime()

dispose()Copy Anchor Link

void dispose()