Models: preferences

Topics, channels and choices, from package:crm_sdk/wire.dart.

import 'package:crm_sdk/wire.dart';

Name	What it is
CrmExportConsentChange	One change of the guest’s choices, in their export: a topic’s, or a channel’s own switch (topic empty).
CrmExportSubscription	One of the guest’s choices about a topic by a channel, in their export.
CrmPreferenceChoice	One choice: a topic, a channel, in or out.
CrmPreferenceState	One channel of a topic, and whether the guest is subscribed by it.
CrmPreferenceTopic	One of the app’s topics, as the guest sees it.
CrmPreferences	The guest’s preferences: every topic of the app’s not archived, and whether all their marketing is off.
CrmPreferencesBody	The guest’s choices, kept as a change only where each differs from what they had; or allOff, “Unsubscribe from all marketing”. wording is the version of the words they agreed under.
CrmPublicPreferences	What PurrCRM’s public preference centre shows: the app’s brand, the address with most of it hidden, and the guest’s preferences.
crmMaxPreferenceChoices	The most choices one body makes.
crmMaxPreferenceWording	The longest wording version a body names.
crmPreferencesWording	The wording version the package’s own preferences screen sends, so that what a guest agreed under is on record (the screen’s words are the package’s l10n strings, versioned with it).

CrmExportConsentChange

class CrmExportConsentChange

One change of the guest’s choices, in their export: a topic’s, or a channel’s own switch (topic empty).

Members of CrmExportConsentChange

CrmExportConsentChange.fromJson()

factory CrmExportConsentChange.fromJson(Map<String, Object?> json)

CrmExportConsentChange()

const CrmExportConsentChange({required DateTime at, required CrmPreferenceChannel channel, required bool subscribed, required String source, String topic = '', String wording = ''})

at

final DateTime at

channel

final CrmPreferenceChannel channel

source

final String source

subscribed

final bool subscribed

topic

final String topic

wording

final String wording

CrmExportSubscription

class CrmExportSubscription

One of the guest’s choices about a topic by a channel, in their export.

Members of CrmExportSubscription

CrmExportSubscription.fromJson()

factory CrmExportSubscription.fromJson(Map<String, Object?> json)

CrmExportSubscription()

const CrmExportSubscription({required String topic, required CrmPreferenceChannel channel, required bool subscribed, required DateTime changedAt, required String source, String wording = ''})

changedAt

final DateTime changedAt

channel

final CrmPreferenceChannel channel

source

final String source

How it was made, in PurrCRM’s word: page, email, staff, import, api, sdk or migration.

subscribed

final bool subscribed

topic

final String topic

The topic’s name.

wording

final String wording

CrmPreferenceChoice

class CrmPreferenceChoice

One choice: a topic, a channel, in or out.

Members of CrmPreferenceChoice

CrmPreferenceChoice.fromJson()

factory CrmPreferenceChoice.fromJson(Map<String, Object?> json)

CrmPreferenceChoice()

const CrmPreferenceChoice({required String topicId, required CrmPreferenceChannel channel, required bool subscribed})

channel

final CrmPreferenceChannel channel

subscribed

final bool subscribed

topicId

final String topicId

toJson

Map<String, Object?> toJson()

CrmPreferenceState

class CrmPreferenceState

One channel of a topic, and whether the guest is subscribed by it.

Members of CrmPreferenceState

CrmPreferenceState.fromJson()

factory CrmPreferenceState.fromJson(Map<String, Object?> json)

CrmPreferenceState()

const CrmPreferenceState({required CrmPreferenceChannel channel, required bool subscribed})

channel

final CrmPreferenceChannel channel

subscribed

final bool subscribed

CrmPreferenceTopic

class CrmPreferenceTopic

One of the app’s topics, as the guest sees it.

Members of CrmPreferenceTopic

CrmPreferenceTopic.fromJson()

factory CrmPreferenceTopic.fromJson(Map<String, Object?> json)

CrmPreferenceTopic()

const CrmPreferenceTopic({required String id, required String name, String description = '', List<CrmPreferenceState> channels = const <CrmPreferenceState>[]})

channels

final List<CrmPreferenceState> channels

The channels it goes by, in PurrCRM’s order, a channel this package does not know yet left for the screen to skip.

description

final String description

id

final String id

name

final String name

CrmPreferences

class CrmPreferences

The guest’s preferences: every topic of the app’s not archived, and whether all their marketing is off.

Members of CrmPreferences

CrmPreferences.fromJson()

factory CrmPreferences.fromJson(Map<String, Object?> json)

CrmPreferences()

const CrmPreferences({List<CrmPreferenceTopic> topics = const <CrmPreferenceTopic>[], bool allOff = false})

allOff

final bool allOff

Every channel’s own switch is off: no topic reaches them until they choose one again.

topics

final List<CrmPreferenceTopic> topics

CrmPreferencesBody

class CrmPreferencesBody

The guest’s choices, kept as a change only where each differs from what they had; or allOff, “Unsubscribe from all marketing”. wording is the version of the words they agreed under.

Members of CrmPreferencesBody

CrmPreferencesBody.fromJson()

factory CrmPreferencesBody.fromJson(Map<String, Object?> json)

CrmPreferencesBody()

const CrmPreferencesBody({List<CrmPreferenceChoice> choices = const <CrmPreferenceChoice>[], bool allOff = false, String wording = ''})

allOff

final bool allOff

choices

final List<CrmPreferenceChoice> choices

wording

final String wording

toJson

Map<String, Object?> toJson()

CrmPublicPreferences

class CrmPublicPreferences

What PurrCRM’s public preference centre shows: the app’s brand, the address with most of it hidden, and the guest’s preferences. The package never asks for it (the page is PurrCRM’s site’s); it is here so that every fixture has a model.

Members of CrmPublicPreferences

CrmPublicPreferences.fromJson()

factory CrmPublicPreferences.fromJson(Map<String, Object?> json)

CrmPublicPreferences()

const CrmPublicPreferences({required String product, String accent = '', String logoUrl = '', String email = '', CrmPreferences preferences = const CrmPreferences()})

accent

final String accent

email

final String email

logoUrl

final String logoUrl

preferences

final CrmPreferences preferences

product

final String product

crmMaxPreferenceChoices

const int crmMaxPreferenceChoices

The most choices one body makes. The Go constant is MaxPreferenceChoices.

crmMaxPreferenceWording

const int crmMaxPreferenceWording

The longest wording version a body names. The Go constant is MaxPreferenceWording.

crmPreferencesWording

const String crmPreferencesWording

The wording version the package’s own preferences screen sends, so that what a guest agreed under is on record (the screen’s words are the package’s l10n strings, versioned with it).

Protocol data: PurrCRM keeps it beside every consent given through the screen, so it stays byte for byte while the screen’s words stay as they are. Only a change to those words takes a new id (crm_sdk/preferences-2, say), with a CHANGELOG entry.