Flutter SDK reference
Every public class, method and value of crm_sdk v1.1.0, written from the package’s own comments. The guides in this section show how they fit together; start with Install.
The package has four libraries:
package:crm_sdk/crm_sdk.dart: The guest CRM for a Flutter app: in-app messages and surveys, the messenger, tickets and the help center, against PurrCRM’s server.package:crm_sdk/go_router.dart: PurrCRM’s routes, for a host that routes with go_router: the messenger’s, the tickets’ and the help center’s, to mount in the host’s own route table (crmGoRoutes), and a navigator that opens them (GoRouterCrmNavigator).package:crm_sdk/testing.dart: Fakes of the PurrCRM service, for a host’s tests and demo builds and for the package’s own tests.package:crm_sdk/wire.dart: A host imports this for the models it handles of its own: PurrCRM’s part of a guest’s export (ExportContactand its parts), say, for a privacy page the host draws, or the messages and parts its own fake of PurrCRM answers with in its tests.
| Page | What is on it |
|---|---|
| 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. |
| crm_sdk: screens and widgets | The screens, the overlay and the widgets package:crm_sdk/crm_sdk.dart exports, and the theme they are drawn with. |
| crm_sdk/go_router.dart | The routes for an app that routes with go_router. |
| crm_sdk/testing.dart | The fake server and client for your tests and demo builds. |
| Models: the messenger, tickets and help | The messenger’s, tickets’ and help center’s models, from package:crm_sdk/wire.dart. |
| Models: in-app messages and surveys | In-app messages, carousels and surveys, from package:crm_sdk/wire.dart. |
| Models: events, content and the app | Events, content blocks and the app’s public face, from package:crm_sdk/wire.dart. |
| Models: push and notices | Devices, pushes and the inbox of notices, from package:crm_sdk/wire.dart. |
| Models: preferences | Topics, channels and choices, from package:crm_sdk/wire.dart. |
| Words: the values the API uses | The fixed values requests and answers use, from package:crm_sdk/wire.dart (some are also in crm_sdk.dart). |