crm_sdk: the facade and setup

What package:crm_sdk/crm_sdk.dart exports to set the package up and talk to it: the facade, its configuration and sign-in, the host’s hooks, links, problems and the stores.

import 'package:crm_sdk/crm_sdk.dart';

Name	What it is
Crm	PurrCRM in a product.
CrmAppUnavailable	PurrCRM refused because the app is archived or deleted (app_unavailable): final.
CrmAuth	How PurrCRM knows who the guest is: a token from the host, which signs its guests in itself, or, for an app whose staff turned on unverified sign-in, the guest’s id alone.
CrmConfig	The product, as PurrCRM needs to know it.
CrmContractError	PurrCRM answered with something the package cannot read: a body that is not JSON, or a model that failed to decode it.
CrmDestination	One of PurrCRM’s pages: a place, and for a conversation, a ticket, a collection or an article, which one (id, an id or a slug).
CrmEvent	crmEvents as a type.
CrmFailure	Why a request did not succeed.
CrmFeature	crmFeatures as a type.
CrmFetchedToken	A token the host’s backend signed for the guest, and when it expires.
CrmFetchedTokens	CrmTokens over the host’s backend: fetch asks it for a token for the guest (null while nobody is signed in), and the token is kept until a little before it expires (earlier, a minute unless told), so that a request never leaves with one about to run out.
CrmHost	The host’s parts.
CrmLink	A place in the host a link may go, as the host declares it (CrmHost.links): its name for PurrCRM’s staff (“Offer page”), its path in the host’s link space, where a part in braces is filled in by whoever writes the link (/offers/{offer_id}, /menu/all?category= {category}), and optionally its page on the web (webUrl: where the link goes on a phone without the app, which may name the same parts) and its screen’s name (screen, as the host tells it to Crm.screen).
CrmLinkSpace	The links that open the app, and the paths in it they name.
CrmLinks	PurrCRM’s link space: the paths of its pages, and which page a link names.
CrmLocalizations	Callers can lookup localized strings with an instance of CrmLocalizations returned by CrmLocalizations.of(context).
CrmNavigator	Takes the guest to one of PurrCRM’s pages, in the host’s own routes: GoRouterCrmNavigator (lib/go_router.dart) for a host that routes with go_router, NavigatorCrmNavigator for one that pushes routes itself.
CrmNotice	One notice in the guest’s inbox: what PurrCRM pushed them, kept to read again.
CrmNotices	The guest’s inbox as the package has it.
CrmOffline	PurrCRM could not be reached, or did not answer in time.
CrmOrderRef	An app’s order reference: what its guests call an order’s reference, the pattern one matches, an example the bot shows, and whether an answer is matched and kept in capitals.
CrmPicture	One picture the guest picked: its bytes, its file name, and its content type (” when the phone did not say).
CrmPicturePicker	Shows the phone’s picker for up to most pictures: the ones picked, none when the guest changed their mind.
CrmPlace	Which of PurrCRM’s pages a CrmDestination is.
CrmPlatform	crmPlatforms as a type.
CrmProblem	PurrCRM answered, and said no: a problem+json body, or, for a response without one, a problem made up from its status.
CrmPublicApp	An app’s public face, which PurrCRM answers anyone who names its key (GET /public/v1/apps/{key}), before a guest signs in: how it is named and coloured, what it has switched on, its currency and order reference, and the SDK it needs.
CrmPublicBrand	An app’s brand as its guests see it: its name (never empty), its accent (#rrggbb, or empty for the product’s own), its logo and where its guests may write.
CrmPushPlatform	crmPushPlatforms as a type.
CrmPushResult	What a push that arrived while the product was open was, to PurrCRM.
CrmPushType	crmPushTypes as a type.
CrmScope	Provides crm to the widgets below it (CrmScope.of): PurrCRM’s screens, its CrmOverlay and its tiles.
CrmSession	A signed-in guest, as the host’s session has them: their id with the host’s sign-in, the name they chose, whether they turned “Help improve …” off, and, when the host holds some of PurrCRM’s parts back from them, which of the app’s it lets them have.
CrmStore	Where PurrCRM keeps what it keeps on the phone, every key under one namespace prefix.
CrmStringsDelegate	The package’s strings, for a MaterialApp’s localizationsDelegates in place of CrmLocalizations.delegate, with what a host may change:
CrmTokens	Where the transport gets the guest token it sends.
MemoryCrmStore	A CrmStore in memory, for tests and a build with no phone to keep anything on.
crmLinksDigest	The digest of what a host declares (CrmLinks), which a check-in sends so that PurrCRM asks for them only when they changed: the links sorted by path then name (as UTF-8 bytes), each its four fields joined by U+001F and ended by U+001E, SHA-256, the first 16 bytes as lowercase hex.
crmSdkVersion	The version of crm_sdk this is.
crmSupportedLocales	The languages the package’s own strings are written in: one for each ARB file in lib/l10n, as flutter gen-l10n lists them.
pictureTypeOf	The content type a picture’s file name says, or ” for one that is not a picture the messenger takes.

Crm

class Crm

PurrCRM in a product.

Members of Crm

Crm()

Crm({required CrmConfig config, required CrmAuth auth, CrmHost host = const CrmHost()})

auth

final CrmAuth auth

Where the guest’s token comes from.

config

final CrmConfig config

The product, as PurrCRM knows it.

host

CrmHost host

The host’s parts. A host that makes the facade before some of its parts exist (it makes it with its services, before its router, say) hands them in once they do, and takes them back as they go: crm.host = crm.host.copyWith(navigator: …).

appFeatures

ValueListenable<Set<CrmFeature>> get appFeatures

PurrCRM’s parts the app has on, whoever is signed in: publicApp’s features, which until PurrCRM answers this start are the ones kept on the phone from the last start that had an answer; on a phone that has never had one, the host’s CrmConfig.initialFeatures until PurrCRM answers. None once PurrCRM says the key is no app’s. It notifies as they change, for a host that shows its own ways in to them.

currentSession

CrmSession? get currentSession

The signed-in guest, as the host last said; null for nobody.

features

Set<CrmFeature> get features

PurrCRM’s parts the guest signed in has: those the app has on (appFeatures), narrowed to those the host names in the session when it names any (CrmSession.features). None for nobody.

isTestMode

bool get isTestMode

Whether this build is in test mode: its app key is a live app’s test test app’s (app_test_…, a staging build’s), whose guests, events and messages PurrCRM keeps apart from the live app’s. The app’s public face says so once PurrCRM has answered at start (publicApp, CrmPublicApp.mode); until then, and with a CRM that cannot be reached, the key’s own prefix does, which PurrCRM gives only to test apps.

publicApp notifies when the answer arrives, for a widget that shows it (CrmTestModeBanner).

notices

ValueListenable<CrmNotices> get notices

The guest’s inbox of notices: what PurrCRM pushed them, kept to read again, with its unread count for the host’s bell. Empty for nobody, and for an app PurrCRM does not deliver for itself.

productName

String get productName

The product’s name as the guest knows it, which PurrCRM’s words say where they name the product: the config’s CrmConfig.productName, else the app’s brand’s name as PurrCRM answered it (publicApp), else nothing.

publicApp

ValueListenable<CrmPublicApp?> get publicApp

The app’s public face, as PurrCRM answered it at start for the config’s app key: its brand, features, currency, order reference and the SDK it needs. Until it answers, the one kept on the phone from the last start that had an answer for the same key; null before either, and once PurrCRM says the key is no app’s.

ready

ValueListenable<bool> get ready

Whether the guest is past the host’s own steps after signing in, as the host last said (setReady): the CrmOverlay shows nothing until they are.

testPhone

ValueListenable<bool> get testPhone

Whether the guest is one of staff’s test phones, as the last check-in said.

unread

ValueListenable<int> get unread

The messenger’s count of unread replies: the badge.

checkNow

Future<int?> checkNow()

Checks in at once, whatever the last check-in’s hint: a test phone asking for its tests. Answers how many arrived, or null when the check-in did not get through or the guest has no in-app messages.

dispose

Future<void> dispose()

Lets go of everything: the lifecycle, the cubits, and the network clients it made. What is waiting to be sent stays on the phone for next time.

forgetPushToken

Future<bool> forgetPushToken()

Lets go of the device’s push token for the guest signed in, so that they are pushed nothing more here: call it before the host signs the guest out, while their token still works (the facade tries again as the session ends, when it may no longer). The token is kept, and is registered for the next guest who signs in. Answers whether PurrCRM took it.

handleLink

Future<bool> handleLink(Uri link)

Whether link, a link the phone handed the host (a universal link, an app link: from the app_links package, a platform channel, a scanned QR code, wherever the host hears of them), is PurrCRM’s: one under the app’s link base (CrmPublicApp.linkBase: https://<the CRM's host>/l/<the app's link name>/<path>, or https://<a host of the app's own>/<path>), or, before the app’s public face has answered, any under /l/ on PurrCRM’s own host. Any other link is the host’s to follow, and the answer is false.

PurrCRM then takes the guest where it goes once a guest is signed in and ready (setReady), as it does a tapped push: one of PurrCRM’s pages through the navigator, an in-app message its link opens (showMessage), or a place in the host through CrmHost.followable and CrmHost.openInApp. An email’s link (one with a click in it) is counted as the email’s click, and every one is a link_opened event. True even when the path goes nowhere: the link was PurrCRM’s.

handlePushArrival

CrmPushResult handlePushArrival(Map<String, Object?> data)

A push arrived while the product was open, with data as the push carried it. A support_reply reads the messenger’s count again (a conversation that is open has the reply already, by its wait); a crm_message from staff makes a test phone ask for its tests at once, whatever the last check-in’s hint, and anyone else check in as they would anyway. The host keeps its own notice for either: the answer says whether it is a reply already read on the screen, or a silent crm_message (a nudge to check in), which is no notice at all.

handlePushTap

bool handlePushTap(Map<String, Object?> data)

A push was tapped, with data as the push carried it: push_opened, whatever the push (PurrCRM’s or the product’s own). Answers whether PurrCRM takes the guest where it goes: a support_reply or a crm_message naming one of PurrCRM’s pages, which opens once the guest is ready (setReady). Any other tap is the host’s to follow.

has

bool has(CrmFeature feature)

Whether the guest signed in has feature (features).

markNoticesRead

Future<bool> markNoticesRead(List<String> ids, {bool all = false})

Marks the notices ids read (those the guest has seen), or every one when all: at once on the phone, and then PurrCRM’s count. Answers whether PurrCRM took it. Each newly read notice is a notice_read event PurrCRM records itself.

mayOpen

bool mayOpen(CrmDestination where)

Whether the guest signed in may open where: its feature is on for them, or it is behind none.

moreNotices

Future<void> moreNotices()

Reads the next page of older notices onto the inbox.

offersByPush

Future<bool?> offersByPush()

The guest’s consent to offers by push, as PurrCRM keeps it, or null when it could not be read.

open

Future<bool> open(CrmDestination where)

Takes the guest to where, through the host’s navigator, in place of where they are (a tapped push): whether it could. An in-app message (CrmPlace.message) is shown over the page instead (showMessage).

openLink

bool openLink(String link)

Follows link, from a message, a reply or an article: one of the CRM’s pages is shown over the page through the navigator, a place in the host goes through its allow-list (CrmHost.followable) and CrmHost.openInApp, and an https page opens in the browser. Answers whether it went anywhere; a link the content’s rules do not allow goes nowhere.

permissionChanged

Future<void> permissionChanged(String permission, {required bool? allowed})

The guest’s answer about permission (‘push’ or ‘location’) is now allowed, or null for not asked yet: an event when an answer this phone already knew changed.

preferences

Future<CrmPreferences?> preferences()

The guest’s preferences: which of the product’s topics of offers and news they hear about, by which channel, as PurrCRM keeps them, or null when they could not be read. The package’s own screen shows them (preferencesScreen); a host that draws its own reads them here.

preferencesScreen

Widget preferencesScreen({void Function()? onExit})

The package’s preferences screen, for a host that mounts it itself (its routes are otherwise /messages/preferences, CrmPlace. preferences). onExit is what Back does when there is no page before it.

refreshNotices

Future<void> refreshNotices()

Reads the inbox’s first page again (a pull to refresh).

registerPushToken

Future<bool> registerPushToken(String token, {CrmPushPlatform? platform})

The device’s push token, from the host’s Firebase: registered with PurrCRM for the guest signed in, at once, and for each guest who signs in after. Called on every start and whenever Firebase gives a new token. platform is the phone’s own unless said. Answers whether PurrCRM took it; one it did not is tried again at the next sign-in or the next call.

screen

void screen(String name)

The host is showing the screen name (never a path or an id): screen_viewed, unless it was the last screen told of.

The names are the host’s own, the same every time a screen shows: staff aim a message at them (InAppMessage.screens), which is held until one of them is on.

session

void session(CrmSession? session)

Who is signed in: session, or nobody when null. Called whenever the host’s own session changes, and only once it has settled: a session still being decided, or refused for now, changes nothing.

A guest who signs in has the messenger’s count read and is checked in for, each by the parts they have (features); the same guest told again with the messenger or in-app messages newly theirs has that read, or is checked in for, then, as when the app’s public face turns one on. Nobody forgets the last guest’s messages, conversations and queued events, so that the next guest on the phone sees only theirs.

setOffersByPush

Future<bool?> setOffersByPush(bool on)

Keeps the guest’s choice about offers by push, made in the host’s own screens: a marketing push goes only to a guest who agreed. Answers the consent as PurrCRM kept it, or null when it could not be kept.

setPreferences

Future<CrmPreferences?> setPreferences(List<CrmPreferenceChoice> choices, {bool allOff = false, String wording = crmPreferencesWording})

Keeps the guest’s choices, made in the host’s own screens, under wording (the version of the words they agreed under), or turns all their offers and news off (allOff). Answers their preferences as PurrCRM kept them, or null when they could not be kept.

setReady

void setReady(bool ready)

Whether the guest is past the host’s steps after signing in, so that a tapped push may take them somewhere and the CrmOverlay may show a message (ready). Called whenever that changes.

show

Future<void> show(CrmDestination where)

Shows where over the page the guest is on, through the host’s navigator, as a tap inside PurrCRM does (a conversation from the messenger’s list, an article from a reply): done once they have come back from it, at once when there is no navigator.

showMessage

Future<bool> showMessage(String id)

Shows the in-app message id that a link names (/messages/show/<id>) over the page the guest is on: only a message whose link opens it, live, to the guest signed in and in its audience. Answers whether the CRM had one to show; the CrmOverlay shows it once the guest is ready.

start

Future<void> start()

Starts PurrCRM, once, as the product starts: the product events kept from the last run are read back, the product’s opening is told (app_opened, and app_updated after an update), and from now on the product’s lifecycle is followed, unless the config says not to.

track

void track(String name, [Map<String, String> props = const {}])

Records that the guest did name, with props: one of the package’s events (CrmEvent), or one the config declared ([CrmConfig. customEvents]). Any other name fails an assert in a debug build and is dropped in a release one: a typo, found at the desk. PurrCRM refuses an event the app does not define on its own, and keeps the rest of its batch.

CrmAppUnavailable

final class CrmAppUnavailable extends CrmProblem

PurrCRM refused because the app is archived or deleted (app_unavailable): final. The transport asks for no fresh token and sends nothing more; the guest is told the app’s support is not available. A CrmProblem, so whatever reads a refusal reads this one too.

Members of CrmAppUnavailable

CrmAppUnavailable()

const CrmAppUnavailable(Problem problem)

CrmAuth

final class CrmAuth

How PurrCRM knows who the guest is: a token from the host, which signs its guests in itself, or, for an app whose staff turned on unverified sign-in, the guest’s id alone.

Members of CrmAuth

CrmAuth.tokens()

const CrmAuth.tokens(CrmTokens tokens, {CrmFailure Function(Object)? tokenFailure})

The token tokens answers: one the host’s backend signs with the app’s identity secret (CrmTokens.fetched), or one of the host’s own sign-in whose key set the app names. When it cannot answer and throws something of the host’s own, tokenFailure says which of PurrCRM’s failures that is (no connection, unless it says otherwise), so that the guest is told what the host would have told them.

CrmAuth.unverified()

const CrmAuth.unverified(String? Function() userId)

No token: the guest’s id, as userId answers it (null while nobody is signed in), sent as X-CRM-User-Id. Only for an app whose staff turned on unverified sign-in in PurrCRM, which anyone can pretend to be anyone in: a prototype, or an app whose messages hold nothing private. Any other app refuses it.

tokenFailure

final CrmFailure Function(Object)? tokenFailure

tokens

final CrmTokens tokens

userId

final String? Function()? userId

The guest’s id, for an unverified app; null for one that signs its guests in with tokens.

CrmConfig

final class CrmConfig

The product, as PurrCRM needs to know it.

Members of CrmConfig

CrmConfig()

const CrmConfig({required Uri apiBase, required String appVersion, required String appKey, String? productName, String storagePrefix = defaultStoragePrefix, Set<CrmFeature> initialFeatures = const {}, Set<String> customEvents = const {}, bool followLifecycle = true, bool autoScreenViews = false, Client? httpClient, String Function()? languageTag, Duration flushEvery = const Duration(seconds: 30), CrmStore? store, DateTime Function()? now})

apiBase

final Uri apiBase

Where PurrCRM’s routes are: PurrCRM’s own host (such as https://crm.example), whose routes are at its root, or a host and the prefix they are under (https://platform.example/crm).

appKey

final String appKey

The product’s public key with PurrCRM (app_…, or app_test_… for its test app, from PurrCRM site’s app settings), sent with every request as X-CRM-App-Key: which app’s contacts, messages and help center the guest is in, whose guest sign-in checks their token, and whose public face PurrCRM answers at start. Required: a CRM refuses a request that names no app.

appVersion

final String appVersion

The product’s version, which every request and every batch of product events says, and which app_updated compares between runs.

autoScreenViews

final bool autoScreenViews

Whether PurrCRM’s own screens say they were shown (screen_viewed) by themselves. Off while the host names every screen it shows, the CRM’s included (Crm.screen).

customEvents

final Set<String> customEvents

The product’s own events, by their words, which PurrCRM knows beside the package’s own (CrmEvent): Crm.track records no other name.

defaultStoragePrefix (static)

static const String defaultStoragePrefix

The prefix PurrCRM’s keys on the phone have unless the host names one.

flushEvery

final Duration flushEvery

How often the product events are sent while any are waiting.

followLifecycle

final bool followLifecycle

Whether the facade follows the product to the background and back by itself (lib/src/state/lifecycle.dart). Widget tests turn it off.

httpClient

final Client? httpClient

The HTTP client PurrCRM talks to PurrCRM and uploads pictures through; a fake of the platform in a test or a demo build. Null for a client of PurrCRM’s own.

initialFeatures

final Set<CrmFeature> initialFeatures

PurrCRM’s parts the host believes the app has on, for a phone that has never had PurrCRM’s answer for appKey (Crm.appFeatures): they stand in until the app’s public face first answers, and never again on that phone, whose kept answer stands in from then on. A CRM that says the key is no app’s (404) leaves none. None unless the host says: nothing of PurrCRM’s shows before PurrCRM says so.

For a host whose parts were on before PurrCRM’s settings decided them (it named them in the session itself), so that the first start of the update with no connection keeps them.

languageTag

final String Function()? languageTag

The guest’s language as a BCP 47 tag (en-GB), asked for on every request so that a problem’s detail follows the phone’s setting.

now

final DateTime Function()? now

What time it is: the phone’s clock, unless a test says otherwise.

productName

final String? productName

The product’s name, as the guest knows it: what PurrCRM’s words call the product. Left out, the app’s brand’s name as PurrCRM answers it for appKey at start (Crm.publicApp) stands in.

storagePrefix

final String storagePrefix

What every key PurrCRM keeps on the phone starts with, followed by a dot (lib/src/events/store.dart): crm unless the host says. A product whose keys had another prefix before (an earlier version of the package’s default, or its own code before it took the package) keeps that one, so that an update loses nothing still waiting to be sent.

store

final CrmStore? store

Where PurrCRM keeps what it keeps on the phone: shared_preferences, under storagePrefix, unless the host hands in another store (one in memory, for a demo build or a test).

CrmContractError

final class CrmContractError extends CrmFailure

PurrCRM answered with something the package cannot read: a body that is not JSON, or a model that failed to decode it. The guest is shown a general message; the detail is for a log.

Members of CrmContractError

CrmContractError()

const CrmContractError(String message)

message

final String message

CrmDestination

final class CrmDestination

One of PurrCRM’s pages: a place, and for a conversation, a ticket, a collection or an article, which one (id, an id or a slug).

Members of CrmDestination

CrmDestination.article()

const CrmDestination.article(String slug)

One article of the help center’s.

CrmDestination.collection()

const CrmDestination.collection(String slug)

One collection of the help center’s.

CrmDestination.conversation()

const CrmDestination.conversation(String id)

One conversation.

CrmDestination.message()

const CrmDestination.message(String id)

One in-app message, which its link opens.

CrmDestination()

const CrmDestination(CrmPlace place, [String id = ''])

CrmDestination.ticket()

const CrmDestination.ticket(String id)

One ticket.

helpCenter (static)

static const CrmDestination helpCenter

The help center’s first screen.

id

final String id

The conversation’s or the ticket’s id, or the collection’s or the article’s slug; empty for the others.

messenger (static)

static const CrmDestination messenger

The messenger’s first screen.

newConversation (static)

static const CrmDestination newConversation

A new conversation.

place

final CrmPlace place

preferences (static)

static const CrmDestination preferences

The guest’s preferences.

tickets (static)

static const CrmDestination tickets

The guest’s tickets.

feature

CrmFeature get feature

The feature that switches this page on: the messenger’s pages are the messenger’s, the help center’s the help center’s; CrmFeature.unknown for the preferences, which no feature holds back (gated).

gated

bool get gated

Whether a feature holds the page back (feature): every page but the preferences, which every guest signed in may open.

link

String get link

The page’s link, in PurrCRM’s link space (CrmLinks).

CrmEvent

enum CrmEvent implements WireWord

crmEvents as a type.

Value	Meaning
appOpened	The product started, or came back to the front.
sessionEnded	The product went to the back, with how long it was in front.
screenViewed	A screen was shown, by its name.
appUpdated	The first run after an update, from one version to another.
pushPermissionChanged	The guest’s answer about notifications changed.
locationPermissionChanged	The guest’s answer about location changed.
pushOpened	A push was tapped.
linkOpened	The product was opened from a link that was PurrCRM’s (handleLink): its path, and where it came from (an email, or any other link).
unknown

Members of CrmEvent

CrmEvent()

const CrmEvent(String word)

parse (static)

static CrmEvent parse(String word)

The event word names, or unknown. A product’s own event is unknown here.

CrmFailure

sealed class CrmFailure implements Exception

Why a request did not succeed. One of three things, and the screens say something different for each.

Members of CrmFailure

CrmFailure()

const CrmFailure()

CrmFeature

enum CrmFeature implements WireWord

crmFeatures as a type.

Value	Meaning
messenger	Conversations with the app’s staff and its help bot, and the guest’s tickets.
helpCenter	The help center’s articles, searched and read in the product.
inAppMessages	Banners, posts, carousels and surveys shown in the product.
unknown

Members of CrmFeature

CrmFeature()

const CrmFeature(String word)

parse (static)

static CrmFeature parse(String word)

The feature word names, or unknown.

CrmFetchedToken

final class CrmFetchedToken

A token the host’s backend signed for the guest, and when it expires.

Members of CrmFetchedToken

CrmFetchedToken()

const CrmFetchedToken(String token, {DateTime? expiresAt})

token, which expires at expiresAt; when that is not given, the token’s own exp claim says (a JWT’s), and a token with neither is kept until PurrCRM refuses it as expired.

expiresAt

final DateTime? expiresAt

token

final String token

expiry

DateTime? get expiry

When the token expires: expiresAt, else its exp claim, read without checking anything about the token; null for neither.

CrmFetchedTokens

class CrmFetchedTokens implements CrmTokens

CrmTokens over the host’s backend: fetch asks it for a token for the guest (null while nobody is signed in), and the token is kept until a little before it expires (earlier, a minute unless told), so that a request never leaves with one about to run out.

Requests that need a token while one is being fetched wait for that one rather than each asking (one fetch in flight at a time). A token PurrCRM refused as expired is forgotten (expired), and so is everything on forget, which a host calls when the guest signs out.

final tokens = CrmFetchedTokens(() async {
  final answer = await myBackend.get('/crm-token');
  return CrmFetchedToken(answer['token'] as String);
});
Crm(config: config, auth: CrmAuth.tokens(tokens));

Members of CrmFetchedTokens

CrmFetchedTokens()

CrmFetchedTokens(Future<CrmFetchedToken?> Function() fetch, {DateTime Function()? now, Duration earlier = const Duration(minutes: 1)})

earlier

final Duration earlier

How long before a token expires a new one is fetched instead.

fetch

final Future<CrmFetchedToken?> Function() fetch

Asks the host’s backend for a token for the guest; null while nobody is signed in. What it throws fails the request, as CrmTokens.current says.

forget

void forget()

Forgets the token, and any on its way: the guest signed out.

CrmHost

final class CrmHost

The host’s parts. A part the host leaves out is a thing PurrCRM does not do: a link into the host goes nowhere without followable, a carousel asks for no permission without askPermission, and so on.

Members of CrmHost

CrmHost()

const CrmHost({String? Function(String)? followable, void Function(String)? openInApp, CrmNavigator? navigator, Future<bool> Function(String)? openExternal, Future<List<({List<int> bytes, String name, String type})>> Function(int)? pickPictures, Future<String> Function()? timeZone, Future<bool> Function(CarouselPermission)? askPermission, void Function(int, int)? onUnreadChanged, List<CrmLink> links = const <CrmLink>[]})

askPermission

final Future<bool> Function(CarouselPermission)? askPermission

Asks the phone for a carousel screen’s permission: whether it was given.

followable

final String? Function(String)? followable

The host’s own allow-list: where a link in a message or a reply goes in the host, or null for nowhere. PurrCRM’s own links are the package’s (CrmLinks) and are not asked about.

links

final List<CrmLink> links

The places in the host a link may go, declared for PurrCRM’s staff (CrmLink): PurrCRM is sent them once a build, when a check-in asks, and offers them in its link picker. What a path opens is still followable’s to say. Empty declares none.

navigator

final CrmNavigator? navigator

Shows PurrCRM’s pages.

onUnreadChanged

final void Function(int, int)? onUnreadChanged

A check-in found the messenger’s count of unread replies changed, from before to after: a chat staff started is pushed to nobody, and a reply to a guest with no pushes is kept only on the host’s notices, so a host with a bell of its own may want to read it again.

openExternal

final Future<bool> Function(String)? openExternal

Opens an https page in the browser: whether it opened.

openInApp

final void Function(String)? openInApp

Goes to followable’s location in the host.

pickPictures

final Future<List<({List<int> bytes, String name, String type})>> Function(int)? pickPictures

The phone’s picker, for the messenger’s pictures.

timeZone

final Future<String> Function()? timeZone

The phone’s IANA time zone (“Europe/London”), which a check-in and the product events say; ” when the phone will not say.

copyWith

CrmHost copyWith({String? Function(String)? followable, void Function(String)? openInApp, CrmNavigator? navigator, Future<bool> Function(String)? openExternal, Future<List<({List<int> bytes, String name, String type})>> Function(int)? pickPictures, Future<String> Function()? timeZone, Future<bool> Function(CarouselPermission)? askPermission, void Function(int, int)? onUnreadChanged, List<CrmLink>? links})

These parts, with those given replaced.

CrmLink

final class CrmLink

A place in the host a link may go, as the host declares it (CrmHost.links): its name for PurrCRM’s staff (“Offer page”), its path in the host’s link space, where a part in braces is filled in by whoever writes the link (/offers/{offer_id}, /menu/all?category= {category}), and optionally its page on the web (webUrl: where the link goes on a phone without the app, which may name the same parts) and its screen’s name (screen, as the host tells it to Crm.screen).

PurrCRM is sent what the host declares once a build (when a check-in asks), and offers it to its staff to add to the app’s destinations, the places its link picker lists. The host’s own router decides what a path opens (CrmHost.followable); declaring one opens nothing by itself.

Members of CrmLink

CrmLink()

const CrmLink({required String name, required String path, String webUrl = '', String screen = ''})

name

final String name

path

final String path

screen

final String screen

webUrl

final String webUrl

toJson

Map<String, Object?> toJson()

The link as PurrCRM’s report takes it (guest.DeclaredLink).

CrmLinkSpace

abstract final class CrmLinkSpace

The links that open the app, and the paths in it they name.

Members of CrmLinkSpace

clickParam (static)

static const String clickParam

The query parameter an email’s link carries its click in.

prefix (static)

static const String prefix

Where the app’s links are under PurrCRM’s own host: /l/<the app's link name>/.

inAppPath (static)

static ({String path, String token})? inAppPath(Uri link, {required String base, required Uri apiBase})

The path in the app link names, and an email’s click it carries (empty for none), when link is one of the app’s: under base, the app’s link base (CrmPublicApp.linkBase), or, while that is not known (empty), under /l/<any name>/ on PurrCRM’s own host (apiBase’s). Null for any other link. http is taken only when apiBase is http (a CRM on the desk). The rules are guest.InAppPath’s.

CrmLinks

abstract final class CrmLinks

PurrCRM’s link space: the paths of its pages, and which page a link names.

Members of CrmLinks

helpCenter (static)

static const String helpCenter

The help center’s first screen; an article is under it, by its slug.

helpCollections (static)

static const String helpCollections

Where the help center’s collections are, each by its slug.

messageShow (static)

static const String messageShow

Where an in-app message is shown by its link, by its id.

messages (static)

static const String messages

The messenger’s first screen; a conversation is under it, by its id.

newConversation (static)

static const String newConversation

A new conversation.

preferences (static)

static const String preferences

The guest’s preferences.

tickets (static)

static const String tickets

The guest’s tickets; a ticket is under it, by its id.

parse (static)

static CrmDestination? parse(String link)

PurrCRM page link names, or null for a link that is not one of the CRM’s: a product’s own page, a page on the web, or a path the package does not know (one from a later version, say). Only the path counts; a query or a fragment is let go.

CrmLocalizations

abstract class CrmLocalizations

Callers can lookup localized strings with an instance of CrmLocalizations returned by CrmLocalizations.of(context).

Applications need to include CrmLocalizations.delegate() in their app’s localizationDelegates list, and the locales they support in the app’s supportedLocales list. For example:

import 'l10n/crm_localizations.dart';

return MaterialApp(
  localizationsDelegates: CrmLocalizations.localizationsDelegates,
  supportedLocales: CrmLocalizations.supportedLocales,
  home: MyApplicationHome(),
);

Update pubspec.yaml

dependencies:
  # Internationalization support.
  flutter_localizations:
    sdk: flutter
  intl: any # Use the pinned version from flutter_localizations

  # Rest of dependencies

iOS Applications

iOS applications define key application metadata, including supported locales, in an Info.plist file that is built into the application bundle. To configure the locales supported by your app, you’ll need to edit this file.

First, open your project’s ios/Runner.xcworkspace Xcode workspace file. Then, in the Project Navigator, open the Info.plist file under the Runner project’s Runner folder.

Next, select the Information Property List item, select Add Item from the Editor menu, then select Localizations from the pop-up menu.

Select and expand the newly-created Localizations item then, for each locale your application supports, add a new item and select the locale you wish to add from the pop-up menu in the Value field. This list should be consistent with the languages listed in the CrmLocalizations.supportedLocales property.

Members of CrmLocalizations

CrmLocalizations()

CrmLocalizations(String locale)

delegate (static)

static const LocalizationsDelegate<CrmLocalizations> delegate

localeName

final String localeName

localizationsDelegates (static)

static const List<LocalizationsDelegate<dynamic>> localizationsDelegates

A list of this localizations delegate along with the default localizations delegates.

Returns a list of localizations delegates containing this delegate along with GlobalMaterialLocalizations.delegate, GlobalCupertinoLocalizations.delegate, and GlobalWidgetsLocalizations.delegate.

Additional delegates can be added by appending to this list in MaterialApp. This list does not have to be used at all if a custom list of delegates is preferred or required.

supportedLocales (static)

static const List<Locale> supportedLocales

A list of this localizations delegate’s supported locales.

articleHelpful

String get articleHelpful

Under an article.

In en, this message translates to: ‘Was this helpful?’

articleNo

String get articleNo

Under an article: it did not help.

In en, this message translates to: ‘No’

articleRelated

String get articleRelated

The heading over an article’s related articles.

In en, this message translates to: ‘Related articles’

articleThanks

String get articleThanks

After the guest said whether an article helped.

In en, this message translates to: ‘Thanks for your feedback.’

articleYes

String get articleYes

Under an article: it helped.

In en, this message translates to: ‘Yes’

back

String get back

A page header’s round back button, as a screen reader says it.

In en, this message translates to: ‘Back’

botAnswerLabel

String get botAnswerLabel

The box where the guest answers the help bot’s question.

In en, this message translates to: ‘Your answer’

botEmailLabel

String get botEmailLabel

The box where the guest gives the help bot their email address.

In en, this message translates to: ‘Your email address’

botHandedOff

String get botHandedOff

Under the help bot’s message handing the guest to a person; followed by when to expect a reply.

In en, this message translates to: ‘You’re through to the team. They’ll reply here.’

botNotEmail

String get botNotEmail

Under the help bot’s box, when what was written is not an email address.

In en, this message translates to: ‘That doesn’t look like an email address.’

botNotOrderRef

String get botNotOrderRef

Under the help bot’s box, when what was written is not an order number.

In en, this message translates to: ‘That doesn’t look like an order number.’

botNotText

String get botNotText

Under the help bot’s box, when nothing, or too much, was written.

In en, this message translates to: ‘Write an answer of up to 500 characters.’

botOrderLabel

String get botOrderLabel

The box where the guest gives the help bot an order’s number, in the app’s own format.

In en, this message translates to: ‘Your order number’

botRefused

String get botRefused

Under the help bot’s box, when the service refused the answer.

In en, this message translates to: ‘The help bot couldn’t take that. Try again, or write to us below.’

carouselContinue

String get carouselContinue

The button under a carousel’s question that lets the guest pick several answers: it goes on with those picked.

In en, this message translates to: ‘Continue’

carouselDone

String get carouselDone

The button of a carousel’s screen that ends it, when the screen has no buttons of its own.

In en, this message translates to: ‘Done’

carouselSkip

String get carouselSkip

In a carousel’s top bar, in place of the close button: closes it.

In en, this message translates to: ‘Skip’

close

String get close

The button that closes a sheet.

In en, this message translates to: ‘Close’

composerAddPicture

String get composerAddPicture

The composer’s button that picks pictures.

In en, this message translates to: ‘Add a picture’

composerHint

String get composerHint

The composer’s placeholder.

In en, this message translates to: ‘Write a message’

composerPictureTooLarge

String get composerPictureTooLarge

A picture too large to send.

In en, this message translates to: ‘That picture is over 5 MB.’

composerPictureWrongType

String get composerPictureWrongType

A file that is not a picture the messenger takes.

In en, this message translates to: ‘Send a JPEG, PNG, GIF or WebP picture.’

composerSend

String get composerSend

The composer’s send button.

In en, this message translates to: ‘Send’

composerSendAsMessage

String get composerSendAsMessage

Beside what the help bot would not take, in the composer: sends it to the team instead.

In en, this message translates to: ‘Send it as a message’

composerWaitForPictures

String get composerWaitForPictures

Send pressed while pictures are still uploading.

In en, this message translates to: ‘Wait for your pictures to finish uploading.’

conversationClosed

String get conversationClosed

The line where a conversation was closed.

In en, this message translates to: ‘The conversation was closed’

conversationClosedNote

String get conversationClosedNote

Above the composer of a closed conversation.

In en, this message translates to: ‘This conversation is closed. Write again and we’ll reopen it.’

conversationEnded

String get conversationEnded

In place of the composer, at its height, when the conversation is not there any more (gone, or the messenger switched off).

In en, this message translates to: ‘This conversation has ended.’

conversationHelloThere

String get conversationHelloThere

At the top of a new conversation, for a guest with no nickname.

In en, this message translates to: ‘Hi there’

conversationNewIntro

String get conversationNewIntro

Under the hello at the top of a new conversation.

In en, this message translates to: ‘Ask us anything, and we’ll get back to you here.’

conversationNewMessage

String get conversationNewMessage

The floating button over a conversation scrolled up when a message arrives below: it scrolls down to it.

In en, this message translates to: ‘New message’

conversationNewTitle

String get conversationNewTitle

The heading of a conversation not yet sent.

In en, this message translates to: ‘New message’

conversationNotSent

String get conversationNotSent

Under the guest’s message when it did not go: tapping the message sends it again.

In en, this message translates to: ‘Not sent · Tap to retry’

conversationPicture

String get conversationPicture

What a screen reader says for a picture in a conversation.

In en, this message translates to: ‘Picture’

conversationPictureFailed

String get conversationPictureFailed

A picture in a conversation that did not load.

In en, this message translates to: ‘This picture can’t be shown.’

conversationPictureOpen

String get conversationPictureOpen

What tapping a picture in a conversation does, to a screen reader: it opens full screen.

In en, this message translates to: ‘Open the picture’

conversationReopened

String get conversationReopened

The line where a closed conversation was opened again.

In en, this message translates to: ‘The conversation was opened again’

conversationSending

String get conversationSending

Under the guest’s message while it is on its way.

In en, this message translates to: ‘Sending…’

conversationToNewest

String get conversationToNewest

The floating round button over a conversation scrolled up: it scrolls down to the newest message.

In en, this message translates to: ‘Go to the newest message’

conversationTrouble

String get conversationTrouble

Shown while the conversation cannot be refreshed.

In en, this message translates to: ‘Can’t reach us right now. We’ll keep trying.’

helpCenterClear

String get helpCenterClear

The button at the end of the help center’s search box that empties it.

In en, this message translates to: ‘Clear the search’

helpCenterNoResults

String get helpCenterNoResults

A search with no results.

In en, this message translates to: ‘No articles match that. Try other words, or send us a message.’

helpCenterPopular

String get helpCenterPopular

The heading over the featured articles.

In en, this message translates to: ‘Popular articles’

helpCenterResults

String get helpCenterResults

The heading over a search’s results.

In en, this message translates to: ‘Results’

helpCenterSearch

String get helpCenterSearch

The help center’s search box.

In en, this message translates to: ‘Search help articles’

helpCenterTitle

String get helpCenterTitle

The heading of the help center.

In en, this message translates to: ‘Help articles’

helpCenterTopics

String get helpCenterTopics

The heading over the help center’s collections.

In en, this message translates to: ‘Topics’

helpStillStuck

String get helpStillStuck

The help heading over contacting us.

In en, this message translates to: ‘Still stuck?’

inAppDismiss

String get inAppDismiss

The button that closes an in-app banner or message.

In en, this message translates to: ‘Dismiss’

inAppPostFromUs

String get inAppPostFromUs

Under the product’s name at the top of a post from no one in particular.

In en, this message translates to: ‘From the team’

inAppTest

String get inAppTest

A tag on an in-app message that staff sent to a test phone, so that it is not taken for the real one.

In en, this message translates to: ‘Test’

inAppTestLabel

String get inAppTestLabel

What a screen reader says for the Test tag on an in-app message.

In en, this message translates to: ‘Test message’

loading

String get loading

What a screen reader hears for the shape of a page still loading.

In en, this message translates to: ‘Loading…’

messengerArticles

String get messengerArticles

The heading over the help center’s featured articles on the messenger.

In en, this message translates to: ‘Suggested articles’

messengerBrowseHelp

String get messengerBrowseHelp

Opens the help center from the messenger.

In en, this message translates to: ‘Browse help articles’

messengerCarryOn

String get messengerCarryOn

On the messenger’s home in place of the button that starts a conversation, while the guest has one open and the product allows one at a time.

In en, this message translates to: ‘Carry on in your open conversation.’

messengerClosedChip

String get messengerClosedChip

The tag on a closed conversation.

In en, this message translates to: ‘Closed’

messengerEarlier

String get messengerEarlier

The heading over the guest’s closed conversations.

In en, this message translates to: ‘Earlier conversations’

messengerNoPreview

String get messengerNoPreview

In the messenger’s list, for a conversation with no words to preview.

In en, this message translates to: ‘Open to see the conversation’

messengerOpen

String get messengerOpen

The heading over the guest’s open conversations.

In en, this message translates to: ‘Your conversations’

messengerReplyDay

String get messengerReplyDay

How soon staff usually answer (ReplyTime day).

In en, this message translates to: ‘We usually reply in a day’

messengerReplyHours

String get messengerReplyHours

How soon staff usually answer (ReplyTime hours).

In en, this message translates to: ‘We usually reply in a few hours’

messengerReplyMinutes

String get messengerReplyMinutes

How soon staff usually answer (ReplyTime minutes).

In en, this message translates to: ‘We usually reply in a few minutes’

messengerSearchHelp

String get messengerSearchHelp

A card on the messenger’s home that opens the help center’s search.

In en, this message translates to: ‘Search for help’

messengerSend

String get messengerSend

The button that starts a new conversation.

In en, this message translates to: ‘Send us a message’

messengerTickets

String get messengerTickets

The heading over the guest’s tickets, and the tickets page’s title.

In en, this message translates to: ‘Your tickets’

messengerTitle

String get messengerTitle

The heading of the messenger, and the row that opens it.

In en, this message translates to: ‘Messages’

messengerYou

String get messengerYou

The author of the guest’s own messages, in a conversation’s preview.

In en, this message translates to: ‘You’

next

String get next

Button that moves on to the next step of a survey or a carousel.

In en, this message translates to: ‘Next’

preferencesAllOff

String get preferencesAllOff

The button at the foot of the preferences screen that turns every topic off on every channel.

In en, this message translates to: ‘Unsubscribe from all offers and news’

preferencesAllOffNow

String get preferencesAllOffNow

On the preferences screen when the guest has turned all marketing off.

In en, this message translates to: ‘All offers and news are off. Turn on a topic to hear about it again.’

preferencesChannelChat

String get preferencesChannelChat

A switch under a topic on the preferences screen: get messages about the topic in the app’s chat with the team.

In en, this message translates to: ‘Chat messages’

preferencesChannelEmail

String get preferencesChannelEmail

A switch under a topic on the preferences screen: hear about the topic by email.

In en, this message translates to: ‘Email’

preferencesChannelInApp

String get preferencesChannelInApp

A switch under a topic on the preferences screen: see messages about the topic inside the app (banners, posts).

In en, this message translates to: ‘In the app’

preferencesChannelPush

String get preferencesChannelPush

A switch under a topic on the preferences screen: hear about the topic by push notification.

In en, this message translates to: ‘Push notifications’

preferencesNone

String get preferencesNone

On the preferences screen when the product has no topics yet.

In en, this message translates to: ‘There is nothing to choose from just now.’

preferencesSaved

String get preferencesSaved

Under the preferences screen’s heading once every change has been kept.

In en, this message translates to: ‘Saved’

preferencesSaving

String get preferencesSaving

Under the preferences screen’s heading while a change goes to us.

In en, this message translates to: ‘Saving…’

preferencesTitle

String get preferencesTitle

The heading of the preferences screen, where the guest chooses which of the product’s topics of offers and news they hear about, and how.

In en, this message translates to: ‘Offers and news’

problemAnswerInvalid

String get problemAnswerInvalid

An answer the help bot refused (422 answer_invalid).

In en, this message translates to: ‘The help bot couldn’t take that answer.’

problemArticleGone

String get problemArticleGone

A help article or collection that is not there, or the help center switched off (404).

In en, this message translates to: ‘That help article isn’t here any more.’

problemAttachmentInvalid

String get problemAttachmentInvalid

A picture the messenger would not take (attachment_invalid).

In en, this message translates to: ‘That picture couldn’t be sent. Try a JPEG, PNG, GIF or WebP of up to 5 MB.’

problemBadRequest

String get problemBadRequest

A service could not read what the app sent, which usually means the app is out of date.

In en, this message translates to: ‘The app sent something that could not be read. If it keeps happening, update the app.’

problemBotMovedOn

String get problemBotMovedOn

An answer to a help-bot question it no longer waits on (409 bot_moved_on).

In en, this message translates to: ‘The help bot has moved on from that question.’

problemConversationGone

String get problemConversationGone

A conversation that is not there, or not the guest’s, or the messenger switched off (404).

In en, this message translates to: ‘We can’t find that conversation.’

problemNotFound

String get problemNotFound

Something the guest asked about no longer exists.

In en, this message translates to: ‘That could not be found. It may have been removed.’

problemOffline

String get problemOffline

The app could not reach the platform at all.

In en, this message translates to: ‘There is no connection. Check your phone’s connection and try again.’

problemRateLimited

String get problemRateLimited

Too many requests, when the service did not say whose limit it was.

In en, this message translates to: ‘That is a lot at once. Give it a little while.’

problemRateLimitedGuest

String get problemRateLimitedGuest

The guest has used up their own requests for the hour.

In en, this message translates to: ‘You have asked for a few already. Give it a little while.’

problemRatingClosed

String get problemRatingClosed

A rating sent for a conversation that has one already, or never asked (rating_closed).

In en, this message translates to: ‘This conversation isn’t asking for a rating any more.’

problemSignInAgain

String get problemSignInAgain

The guest’s session ran out and could not be renewed.

In en, this message translates to: ‘Your session has expired. Sign in again.’

problemSurveyClosed

String get problemSurveyClosed

A survey’s answers after it was finished, dismissed or stopped (survey_closed).

In en, this message translates to: ‘This survey has closed. Thanks all the same.’

problemTicketGone

String get problemTicketGone

A ticket that is not there, or not the guest’s (404).

In en, this message translates to: ‘We can’t find that ticket.’

problemUnavailable

String get problemUnavailable

A service is temporarily unavailable.

In en, this message translates to: ‘That cannot be done just now. Try again in a moment.’

ratingAsk

String get ratingAsk

The heading of the rating prompt at the end of a conversation.

In en, this message translates to: ‘How did we do?’

ratingRemarkHint

String get ratingRemarkHint

The remark box under the stars.

In en, this message translates to: ‘Anything to add? (optional)’

ratingSend

String get ratingSend

Sends the rating.

In en, this message translates to: ‘Send rating’

refusalRefused

String get refusalRefused

Why something the guest sent was refused, when PurrCRM gave no reason the app knows.

In en, this message translates to: ‘That was not accepted.’

retrySoon

String get retrySoon

After a limit was reached, when the wait is under a minute.

In en, this message translates to: ‘You can try again in a moment.’

showMore

String get showMore

Button that loads more search results.

In en, this message translates to: ‘Show more’

somethingWentWrong

String get somethingWentWrong

Shown when a service answered with something the app could not understand, or said no without saying why.

In en, this message translates to: ‘Something went wrong. Try again in a moment.’

surveyChoose

String get surveyChoose

A dropdown question with nothing chosen yet.

In en, this message translates to: ‘Choose one’

surveyDiscard

String get surveyDiscard

In surveyDiscardTitle’s dialog: leave the survey, and its answers with it.

In en, this message translates to: ‘Discard’

surveyDiscardTitle

String get surveyDiscardTitle

The question asked when the guest goes back (the system’s back, or a swipe) from the first step of a survey they have started answering.

In en, this message translates to: ‘Discard your answers?’

surveyDone

String get surveyDone

The button on a survey’s thank-you step.

In en, this message translates to: ‘Done’

surveyEmojiBad

String get surveyEmojiBad

The second face of an emoji question.

In en, this message translates to: ‘Unhappy’

surveyEmojiGood

String get surveyEmojiGood

The fourth face of an emoji question.

In en, this message translates to: ‘Happy’

surveyEmojiOkay

String get surveyEmojiOkay

The middle face of an emoji question.

In en, this message translates to: ‘Neutral’

surveyEmojiVeryBad

String get surveyEmojiVeryBad

The first face of an emoji question.

In en, this message translates to: ‘Very unhappy’

surveyEmojiVeryGood

String get surveyEmojiVeryGood

The last face of an emoji question.

In en, this message translates to: ‘Very happy’

surveyKeepGoing

String get surveyKeepGoing

In surveyDiscardTitle’s dialog: stay in the survey.

In en, this message translates to: ‘Keep going’

surveyNotAnswered

String get surveyNotAnswered

What a screen reader says of a survey’s scale before a score is picked.

In en, this message translates to: ‘Not answered’

surveyNotSent

String get surveyNotSent

A survey’s submit that did not reach us.

In en, this message translates to: ‘Your answers didn’t send. Try again.’

surveyOptional

String get surveyOptional

Beside a question that need not be answered.

In en, this message translates to: ‘Optional’

surveyOther

String get surveyOther

The option for an answer of the guest’s own.

In en, this message translates to: ‘Other’

surveyOtherHint

String get surveyOtherHint

The box for the words with Other.

In en, this message translates to: ‘Tell us more’

surveyQuickQuestion

String get surveyQuickQuestion

The small heading at the top of a survey in a sheet.

In en, this message translates to: ‘Quick question’

surveyRequired

String get surveyRequired

Under a required question the guest tried to skip.

In en, this message translates to: ‘Answer this one to go on.’

surveySending

String get surveySending

A survey’s Next or Send button while the answers go to us; it waits, turned off, with a spinner beside the words.

In en, this message translates to: ‘Sending…’

surveyStart

String get surveyStart

The button on a large survey’s introduction.

In en, this message translates to: ‘Start’

surveySubmit

String get surveySubmit

The button that finishes a survey.

In en, this message translates to: ‘Send’

surveyThanks

String get surveyThanks

A survey’s end, when it has no thank-you step of its own.

In en, this message translates to: ‘Thank you!’

testPhoneCheckNow

String get testPhoneCheckNow

The row in Account’s Test phone group that asks PurrCRM at once for the tests staff sent this phone (CrmCubit.checkNow).

In en, this message translates to: ‘Check for tests now’

testPhoneChecking

String get testPhoneChecking

Under testPhoneCheckNow while it asks.

In en, this message translates to: ‘Checking…’

testPhoneDetail

String get testPhoneDetail

Under testPhoneCheckNow before it was pressed: what the group is for.

In en, this message translates to: ‘For trying messages from PurrCRM on this phone. Tests also arrive when the app opens.’

testPhoneFailed

String get testPhoneFailed

Under testPhoneCheckNow when the check-in did not get through.

In en, this message translates to: ‘Could not check. Try again.’

testPhoneHeading

String get testPhoneHeading

The Account group shown only to a guest staff chose as a test phone (Checkin.test_phone), to try messages from PurrCRM on their own phone.

In en, this message translates to: ‘Test phone’

ticketDetails

String get ticketDetails

The heading over a ticket’s fields.

In en, this message translates to: ‘Details’

ticketMessages

String get ticketMessages

The heading over a ticket’s conversation.

In en, this message translates to: ‘Messages’

ticketNo

String get ticketNo

A yes-or-no field that is no.

In en, this message translates to: ‘No’

ticketStateInProgress

String get ticketStateInProgress

A ticket’s state.

In en, this message translates to: ‘In progress’

ticketStateResolved

String get ticketStateResolved

A ticket’s state.

In en, this message translates to: ‘Resolved’

ticketStateSubmitted

String get ticketStateSubmitted

A ticket’s state.

In en, this message translates to: ‘Submitted’

ticketStateUnknown

String get ticketStateUnknown

A ticket in a state this app does not know.

In en, this message translates to: ‘Updated’

ticketStateWaiting

String get ticketStateWaiting

A ticket’s state: staff need something from the guest.

In en, this message translates to: ‘Waiting on you’

ticketYes

String get ticketYes

A yes-or-no field that is yes.

In en, this message translates to: ‘Yes’

ticketsEmpty

String get ticketsEmpty

The tickets page with none.

In en, this message translates to: ‘You have no tickets.’

today

String get today

The inbox heading over today’s notices.

In en, this message translates to: ‘Today’

tryAgain

String get tryAgain

Button that repeats whatever just failed.

In en, this message translates to: ‘Try again’

yesterday

String get yesterday

When a notice from yesterday came.

In en, this message translates to: ‘Yesterday’

articleUpdated

String articleUpdated(DateTime at)

When an article last changed.

In en, this message translates to: ‘Updated {at}’

botArticleOpen

String botArticleOpen(String title)

What a screen reader says of an article the help bot suggests.

In en, this message translates to: ‘Open the article {title}’

carouselPage

String carouselPage(int page, int pages)

A screen reader’s label for where the guest is in a carousel.

In en, this message translates to: ‘Page {page} of {pages}’

carouselProgress

String carouselProgress(int percent)

A screen reader’s label for a carousel’s progress bar: how much of the way to its end the guest has come.

In en, this message translates to: ‘{percent}% of the way’

composerRemovePicture

String composerRemovePicture(int number)

The button on a picture waiting to be sent.

In en, this message translates to: ‘Remove picture {number}’

composerTooLong

String composerTooLong(int max)

A message that is too long.

In en, this message translates to: ‘A message can be up to {max} characters.’

composerTooManyPictures

String composerTooManyPictures(int max)

More pictures than one message takes.

In en, this message translates to: ‘You can send up to {max} pictures in one message.’

composerUploadFailed

String composerUploadFailed(int number)

A picture that did not upload.

In en, this message translates to: ‘Picture {number} didn’t upload. Remove it and try again.’

composerUploading

String composerUploading(int number)

What a screen reader says for a picture still uploading.

In en, this message translates to: ‘Picture {number}, uploading’

conversationDate

String conversationDate(DateTime date)

The line across a conversation where an older day starts: the date.

In en, this message translates to: ‘{date}’

conversationDayName

String conversationDayName(DateTime day)

The line across a conversation where a day of the past week starts: the day’s name.

In en, this message translates to: ‘{day}’

conversationHello

String conversationHello(String name)

At the top of a new conversation, by the guest’s nickname.

In en, this message translates to: ‘Hi {name}’

conversationSaid

String conversationSaid(String name, DateTime time)

What a screen reader says before a part: who wrote it and when.

In en, this message translates to: ‘{name}, {time}’

conversationTitle

String conversationTitle(String product)

The heading of a conversation.

In en, this message translates to: ‘{product} team’

helpCollectionCount

String helpCollectionCount(int count)

How many articles a topic has.

In en, this message translates to: ‘{count, plural, =1{1 article} other{{count} articles}}’

helpMessagesSubtitle

String helpMessagesSubtitle(String product)

Under Messages on the help page.

In en, this message translates to: ‘Chat with the {product} team’

inAppFromTeam

String inAppFromTeam(String name, String product)

Who a full-screen message is from, under its words.

In en, this message translates to: ‘From {name} at {product}’

inAppFromUs

String inAppFromUs(String product)

A full-screen message with no teammate named.

In en, this message translates to: ‘From {product}’

inAppPostTeam

String inAppPostTeam(String product)

Under a teammate’s first name at the top of a post from them.

In en, this message translates to: ‘{product} team’

messengerBackAt

String messengerBackAt(DateTime time)

Staff are not at work now, and are back later today.

In en, this message translates to: ‘We’re back at {time}’

messengerBackOn

String messengerBackOn(DateTime day, DateTime time)

Staff are not at work now, and are back on a later day.

In en, this message translates to: ‘We’re back {day} at {time}’

messengerHeading

String messengerHeading(String product)

The big heading on the messenger’s first screen.

In en, this message translates to: ‘Talk to the {product} team’

messengerNames

String messengerNames(String names, String last)

The teammates shown on the messenger’s home, under their faces: the others separated by commas, then the last.

In en, this message translates to: ‘{names} and {last}’

messengerNothingYet

String messengerNothingYet(String product)

The messenger with no conversations.

In en, this message translates to: ‘No messages yet. Ask us anything about {product}.’

messengerTeam

String messengerTeam(String product)

The author of a part written by the messenger or an unnamed member of staff.

In en, this message translates to: ‘{product}’

messengerUnread

String messengerUnread(int count)

The count on a conversation with unread replies.

In en, this message translates to: ‘{count, plural, =1{1 unread} other{{count} unread}}’

messengerYouSaid

String messengerYouSaid(String text)

In the messenger’s list, what the guest wrote last in a conversation.

In en, this message translates to: ‘You: {text}’

noticeAtTime

String noticeAtTime(DateTime time)

When a notice from today came.

In en, this message translates to: ‘{time}’

noticeOnDate

String noticeOnDate(DateTime date)

When an older notice came: the date.

In en, this message translates to: ‘{date}’

noticeOnDay

String noticeOnDay(DateTime day)

When a notice from the past week came: the day’s name.

In en, this message translates to: ‘{day}’

of (static)

static CrmLocalizations? of(BuildContext context)

preferencesIntro

String preferencesIntro(String product)

Under preferencesTitle: what the screen is for. Service messages are not affected by any switch on it.

In en, this message translates to: ‘Choose what {product} sends you about each topic, and how. Messages about your account and orders always come.’

ratingGiven

String ratingGiven(int count)

The rating prompt once answered.

In en, this message translates to: ‘You rated this {count} out of 5’

ratingStar

String ratingStar(int count)

A star button in the rating prompt.

In en, this message translates to: ‘{count, plural, =1{1 star} other{{count} stars}}’

retryAt

String retryAt(DateTime time)

After a limit was reached: the time of day when asking again is worth it.

In en, this message translates to: ‘You can try again at {time}.’

stepOf

String stepOf(int step, int total)

What a screen reader says for the dots over the steps after signing in.

In en, this message translates to: ‘Step {step} of {total}’

surveyScaleEnds

String surveyScaleEnds(int low, String lowLabel, int high, String highLabel)

What a screen reader adds about a survey’s scale: what its two ends mean.

In en, this message translates to: ‘{low} is {lowLabel}, {high} is {highLabel}’

surveyScore

String surveyScore(int score, int max)

A screen reader’s label for one number on a scale.

In en, this message translates to: ‘{score} out of {max}’

surveyStars

String surveyStars(int count)

A screen reader’s label for a star rating.

In en, this message translates to: ‘{count} of 5 stars’

testPhoneArrived

String testPhoneArrived(int count)

Under testPhoneCheckNow once it has asked: how many tests arrived, which then show.

In en, this message translates to: ‘{count, plural, =0{Nothing waiting} =1{1 test arrived} other{{count} tests arrived}}’

ticketLabel

String ticketLabel(String ref, String title, String state)

What a screen reader says for a ticket in a list.

In en, this message translates to: ‘{ref}, {title}, {state}’

ticketProgress

String ticketProgress(String state, int step, int steps)

What a screen reader says for a ticket’s steps: where it is, and how far along.

In en, this message translates to: ‘{state}, step {step} of {steps}’

ticketResolvedOn

String ticketResolvedOn(DateTime at)

When a ticket was resolved.

In en, this message translates to: ‘Resolved on {at}’

ticketUpdated

String ticketUpdated(DateTime at)

When a ticket last changed.

In en, this message translates to: ‘Updated {at}’

CrmNavigator

abstract interface class CrmNavigator

Takes the guest to one of PurrCRM’s pages, in the host’s own routes: GoRouterCrmNavigator (lib/go_router.dart) for a host that routes with go_router, NavigatorCrmNavigator for one that pushes routes itself.

Members of CrmNavigator

open

Future<bool> open(CrmDestination where)

Shows where in place of where the guest is, as a tapped push does: whether it could.

push

Future<void> push(CrmDestination where)

Shows where over the page the guest is on, as a tap inside PurrCRM does, so that Back comes back to it: done once they have come back.

CrmNotice

class CrmNotice

One notice in the guest’s inbox: what PurrCRM pushed them, kept to read again.

Members of CrmNotice

CrmNotice.fromJson()

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

CrmNotice()

const CrmNotice({required String id, required CrmPushType type, required String title, required String body, required DateTime createdAt, String link = '', DateTime? readAt})

body

final String body

createdAt

final DateTime createdAt

id

final String id

link

final String link

A path in the app, which the app’s allow-list decides whether to open; empty for none.

readAt

final DateTime? readAt

When the guest read it, or null for unread.

title

final String title

type

final CrmPushType type

What the notice is about; unknown for a type the package does not handle, which is still the guest’s to read.

unread

bool get unread

Whether the guest has not read it.

readOn

CrmNotice readOn(DateTime at)

The notice read at at.

CrmNotices

class CrmNotices

The guest’s inbox as the package has it.

Members of CrmNotices

CrmNotices()

const CrmNotices({List<CrmNotice> notices = const <CrmNotice>[], int unread = 0, bool loaded = false, bool loading = false, CrmFailure? failure, String nextBefore = ''})

failure

final CrmFailure? failure

Why the last read failed, or null.

loaded

final bool loaded

Whether a page has been read since the guest signed in.

loading

final bool loading

Whether a page is on its way.

nextBefore

final String nextBefore

The notice older ones are read before; empty when there are no more.

notices

final List<CrmNotice> notices

The notices read so far, newest first.

unread

final int unread

The whole inbox’s unread count: the bell’s number.

hasMore

bool get hasMore

Whether there are older notices to read (NoticesKeeper.more).

copyWith

CrmNotices copyWith({List<CrmNotice>? notices, int? unread, bool? loaded, bool? loading, CrmFailure? failure, bool clearFailure = false, String? nextBefore})

CrmOffline

final class CrmOffline extends CrmFailure

PurrCRM could not be reached, or did not answer in time. Nothing is known about whether it acted: a POST that ends this way is not retried.

Members of CrmOffline

CrmOffline()

const CrmOffline(Object cause)

cause

final Object cause

timedOut

bool get timedOut

PurrCRM did not answer in time, rather than not being reached.

CrmOrderRef

class CrmOrderRef

An app’s order reference: what its guests call an order’s reference, the pattern one matches, an example the bot shows, and whether an answer is matched and kept in capitals. A collecting part carries it, so that the package checks an answer as PurrCRM will.

Members of CrmOrderRef

CrmOrderRef.fromJson()

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

CrmOrderRef()

const CrmOrderRef({required String label, required String pattern, required String example, String prop = '', bool upper = false})

example

final String example

One that matches, which the bot shows.

label

final String label

What the app calls it: “Order number”.

pattern

final String pattern

A regular expression the whole answer matches.

prop

final String prop

The event prop that prefills a ticket’s order; empty for none.

upper

final bool upper

Matched and kept in capitals.

hint

String get hint

What the box says to an answer that is not one: “Order numbers look like …”, in the app’s own words.

check

String? check(String value)

The answer as PurrCRM keeps it, or null when PurrCRM would refuse it. A pattern this phone cannot read leaves the check to PurrCRM.

CrmPicture

typedef CrmPicture = ({List<int> bytes, String name, String type})

One picture the guest picked: its bytes, its file name, and its content type (” when the phone did not say).

CrmPicturePicker

typedef CrmPicturePicker = Future<List<({List<int> bytes, String name, String type})>> Function(int)

Shows the phone’s picker for up to most pictures: the ones picked, none when the guest changed their mind.

CrmPlace

enum CrmPlace

Which of PurrCRM’s pages a CrmDestination is.

Value	Meaning
messenger	The messenger’s first screen: the open conversations, the reply line, the featured articles and the tickets.
newConversation	A new conversation, which the guest’s first message starts.
conversation	One conversation, by its id.
tickets	The guest’s tickets.
ticket	One ticket, by its id.
helpCenter	The help center’s first screen: its collections and its search.
collection	One collection of articles, by its slug.
article	One article, by its slug.
message	One in-app message whose link opens it, by its id: shown over the page the guest is on (Crm.showMessage), not a page of its own.
preferences	The guest’s preferences: which topics of offers and news they hear about, by which channel.

CrmPlatform

enum CrmPlatform implements WireWord

crmPlatforms as a type.

Values: ios, android, web, unknown.

Members of CrmPlatform

CrmPlatform()

const CrmPlatform(String word)

parse (static)

static CrmPlatform parse(String word)

The platform word names, or unknown.

CrmProblem

final class CrmProblem extends CrmFailure

PurrCRM answered, and said no: a problem+json body, or, for a response without one, a problem made up from its status.

Members of CrmProblem

CrmProblem()

const CrmProblem(Problem problem)

CrmProblem.of()

CrmProblem.of({required int status, required String code, String title = '', String detail = '', String? scope, int? retryAfterSeconds, String requestId = ''})

A refusal made up from its parts, as PurrCRM would have answered it: what a host’s sign-in refusing to give a token is, say, or what a host’s fake of one of the package’s APIs throws in a test. code is one of the guest routes’ error codes, and scope, for a 429, whose limit it was, each as its word.

problem

final Problem problem

status

int get status

CrmPublicApp

class CrmPublicApp

An app’s public face, which PurrCRM answers anyone who names its key (GET /public/v1/apps/{key}), before a guest signs in: how it is named and coloured, what it has switched on, its currency and order reference, and the SDK it needs. Nothing in it is secret.

Members of CrmPublicApp

CrmPublicApp.fromJson()

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

CrmPublicApp()

const CrmPublicApp({required String key, String mode = 'live', required CrmPublicBrand brand, List<String> features = const <String>[], String currency = '', CrmOrderRef? orderRef, String minSdkVersion = '', String linkBase = '', List<String> languages = const <String>[]})

brand

final CrmPublicBrand brand

currency

final String currency

The ISO 4217 code its money is in; empty when its staff named none.

features

final List<String> features

The parts of the guest experience it has on, by their words.

key

final String key

The app’s public key, the one asked for.

languages

final List<String> languages

PurrCRM picks one of them for each guest and sends the content in it: the package picks nothing, and a host need not either.

linkBase

final String linkBase

Where the app’s links are: https://<the CRM's host>/l/<name>, or https://<a host of the app's own>; empty while it has no link domain, and from a CRM before links.

minSdkVersion

final String minSdkVersion

The oldest SDK its staff want its guests on (“0.6.0”); empty for none.

mode

final String mode

live, or test for a live app’s test app: a staging build’s, whose data is kept apart from the live app’s. Live from a CRM that says neither.

orderRef

final CrmOrderRef? orderRef

Its order reference; null for none.

isTest

bool get isTest

Whether the key is a test app’s.

CrmPublicBrand

class CrmPublicBrand

An app’s brand as its guests see it: its name (never empty), its accent (#rrggbb, or empty for the product’s own), its logo and where its guests may write.

Members of CrmPublicBrand

CrmPublicBrand.fromJson()

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

CrmPublicBrand()

const CrmPublicBrand({required String name, String accent = '', String logoUrl = '', String supportEmail = ''})

accent

final String accent

logoUrl

final String logoUrl

name

final String name

supportEmail

final String supportEmail

CrmPushPlatform

enum CrmPushPlatform implements WireWord

crmPushPlatforms as a type.

Values: android, ios, web, unknown.

Members of CrmPushPlatform

CrmPushPlatform()

const CrmPushPlatform(String word)

parse (static)

static CrmPushPlatform parse(String word)

The platform word names, or unknown.

CrmPushResult

final class CrmPushResult

What a push that arrived while the product was open was, to PurrCRM.

Members of CrmPushResult

CrmPushResult()

const CrmPushResult({bool isCrm = false, bool replyOnScreen = false, String noticeId = '', bool silent = false})

isCrm

final bool isCrm

One of PurrCRM’s pushes (a support_reply or a crm_message), which the CRM has acted on: the messenger’s count read again, a check-in made.

noticeId

final String noticeId

The host’s notice the push is, as its data names it; empty for none.

replyOnScreen

final bool replyOnScreen

A reply in a conversation or a ticket that is on the screen, whose wait has brought the reply and marked it read already. The host’s notice for it (PurrCRM pushes a reply at once, usually before that read reaches it, so the platform keeps one) can be marked read too.

silent

final bool silent

A crm_message with nothing to show: a nudge PurrCRM sends an app left open to check in for an in-app message queued for its guest (its data says nudge), which PurrCRM has done. It carries no notification and is no notice, so the host shows nothing for it.

CrmPushType

enum CrmPushType implements WireWord

crmPushTypes as a type.

Value	Meaning
supportReply	A reply in one of the guest’s conversations, or a change to one of their tickets.
crmMessage	A message the app’s staff sent from PurrCRM.
unknown

Members of CrmPushType

CrmPushType()

const CrmPushType(String word)

parse (static)

static CrmPushType parse(String word)

The type word names, or unknown: a push of the product’s own, say.

CrmScope

class CrmScope extends StatelessWidget

Provides crm to the widgets below it (CrmScope.of): PurrCRM’s screens, its CrmOverlay and its tiles. A host mounts one above its MaterialApp, once, so that its routes, its Navigator and the overlay in its builder are all below it.

The package’s own screens read the messenger’s cubit through it too; that is the package’s, and a host never reads it.

Members of CrmScope

CrmScope()

const CrmScope({Key? key, required Crm crm, required Widget child})

child

final Widget child

crm

final Crm crm

maybeOf (static)

static Crm? maybeOf(BuildContext context)

The facade of the nearest CrmScope above context, or null for none.

of (static)

static Crm of(BuildContext context)

The facade of the nearest CrmScope above context. It may be asked in a State’s initState: a scope’s facade is the one object for as long as the product runs, and nothing below is rebuilt for it.

CrmSession

final class CrmSession

A signed-in guest, as the host’s session has them: their id with the host’s sign-in, the name they chose, whether they turned “Help improve …” off, and, when the host holds some of PurrCRM’s parts back from them, which of the app’s it lets them have.

Which of PurrCRM’s parts a guest has is the app’s to say: the features its staff switched on in PurrCRM site, which PurrCRM answers with the app’s public face (CrmPublicApp.features) and the facade keeps on the phone for a start with no connection. A host that says nothing (features null) leaves it at that. A host that names features narrows it: the guest has a part only when the app has it on and the host names it. A host cannot switch on a part the app has off.

Members of CrmSession

CrmSession()

const CrmSession({required String guestId, String displayName = '', bool productEventsOff = false, Set<CrmFeature>? features})

displayName

final String displayName

The name the guest chose, for a hello in a new conversation; empty when they have none yet.

features

final Set<CrmFeature>? features

PurrCRM’s parts the host lets this guest have, of those the app has on; null for every one the app has on. A product’s own features are the host’s, and are not here.

guestId

final String guestId

The guest’s id with the host’s sign-in (the token’s subject), which the product events are kept with.

productEventsOff

final bool productEventsOff

The guest turned product events off: nothing is kept or sent for them (lib/src/events/tracker.dart).

has

bool has(CrmFeature feature)

Whether the host lets this guest have feature, if the app has it on: always, when the host names no features.

withFeatures

CrmSession withFeatures(Set<CrmFeature>? features)

This session with features in place of its own.

CrmStore

abstract interface class CrmStore

Where PurrCRM keeps what it keeps on the phone, every key under one namespace prefix.

Members of CrmStore

prefix

String get prefix

What every key starts with, followed by a dot: crm unless the host names another (CrmConfig.storagePrefix).

read

Future<String?> read(String name)

What is kept under name, or null for nothing.

remove

Future<void> remove(String name)

Forgets what is kept under name.

write

Future<void> write(String name, String value)

Keeps value under name.

CrmStringsDelegate

class CrmStringsDelegate extends LocalizationsDelegate<CrmLocalizations>

The package’s strings, for a MaterialApp’s localizationsDelegates in place of CrmLocalizations.delegate, with what a host may change:

• strings: its own CrmLocalizations for a language, by BCP 47 tag (cy, pt-BR, zh-Hant, in any case, _ or -; a tag of a language alone serves each of its regions and scripts), for one the package has no ARB file for, or to say its own words in one it has. The most precise tag that fits a locale wins: zh-Hant-TW, then zh-Hant, then zh-TW, then zh. The host writes them as gen-l10n would (a class that extends CrmLocalizations, or the English one to change a few).
• supportedLocales: the languages the package may speak, when the host wants fewer than it has: the package’s and strings’ when left out. In a language not among them the package speaks English.

Members of CrmStringsDelegate

CrmStringsDelegate()

CrmStringsDelegate({Map<String, CrmLocalizations> strings = const {}, List<Locale>? supportedLocales})

strings

final Map<String, CrmLocalizations> strings

The host’s own strings, by language tag in its canonical form (pt_br given is pt-BR here).

supportedLocales

final List<Locale> supportedLocales

The languages the package may speak.

CrmTokens

abstract interface class CrmTokens

Where the transport gets the guest token it sends. The host implements it, over its own sign-in.

Several requests can run at once, and several can be refused as expired together; an implementation exchanges one fresh token for all of them rather than one each.

Members of CrmTokens

CrmTokens.fetched()

factory CrmTokens.fetched(Future<CrmFetchedToken?> Function() fetch, {DateTime Function()? now, Duration earlier})

Tokens fetched from the host’s own backend, which signs one for the guest with the app’s identity secret: fetch answers one (null while nobody is signed in), which is kept until a minute before it expires, fetched once for every request waiting on it, and forgotten when PurrCRM refuses it as expired. A host that signs the guest out keeps the CrmFetchedTokens itself to call CrmFetchedTokens.forget.

current

Future<String?> current()

The guest token to send, exchanging a fresh one first when it has run out, or null when the guest is signed out.

When it cannot answer (the host’s sign-in could not be reached, or refused the exchange), it throws, and the request fails without being sent: as the CrmFailure thrown, or as what the transport’s tokenFailure makes of any other exception (no connection, unless the host says otherwise).

expired

Future<void> expired(String token)

Forgets token, which PurrCRM has just refused as expired, so that the next current answers a new one. A token that is no longer the current one is already forgotten, and asking again changes nothing.

MemoryCrmStore

class MemoryCrmStore implements CrmStore

A CrmStore in memory, for tests and a build with no phone to keep anything on. It keeps each value under its whole key, prefix and all, so that a test can see the keys a store on the phone would use.

Members of MemoryCrmStore

MemoryCrmStore()

MemoryCrmStore({required String prefix})

values

final Map<String, String> values

What is kept, by whole key.

crmLinksDigest

String crmLinksDigest(Iterable<CrmLink> links)

The digest of what a host declares (CrmLinks), which a check-in sends so that PurrCRM asks for them only when they changed: the links sorted by path then name (as UTF-8 bytes), each its four fields joined by U+001F and ended by U+001E, SHA-256, the first 16 bytes as lowercase hex.

crmSdkVersion

const String crmSdkVersion

The version of crm_sdk this is. CHANGELOG.md says the oldest CRM each version works against.

crmSupportedLocales

const List<Locale> crmSupportedLocales

The languages the package’s own strings are written in: one for each ARB file in lib/l10n, as flutter gen-l10n lists them.

pictureTypeOf

String pictureTypeOf(String fileName)

The content type a picture’s file name says, or ” for one that is not a picture the messenger takes.