Models: push and notices

Devices, pushes and the inbox of notices, from package:crm_sdk/wire.dart.

import 'package:crm_sdk/wire.dart';

Name	What it is
CrmConsent	What PurrCRM keeps of the guest’s choices about its pushes.
CrmConsentBody	What the guest chose in the host’s own screens about PurrCRM’s pushes.
CrmDeviceBody	The device the host’s Firebase gave a registration token for, which the package registers on every start and whenever the token changes.
CrmExportDevice	One device the guest registered for pushes, in their export, without its token.
CrmExportNotice	One notice in the guest’s inbox, in their export.
CrmForgetDeviceBody	The token the package registered, forgotten as the guest signs out so that the next guest on the phone is not pushed the last one’s.
CrmNoticePage	A page of the guest’s inbox, newest first.
CrmNoticesReadBody	The notices the guest has seen, or all of them.
crmDefaultNoticePage	A page of the inbox by default, and the most one page may be.
crmMaxNoticePage
crmMaxNoticesRead	The most notices one read may name.
crmMaxPushTokenBytes	The longest registration token PurrCRM keeps.

CrmConsent

class CrmConsent

What PurrCRM keeps of the guest’s choices about its pushes.

Members of CrmConsent

CrmConsent.fromJson()

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

CrmConsent()

const CrmConsent({bool offersByPush = false})

offersByPush

final bool offersByPush

A marketing push goes only to a guest who agreed.

CrmConsentBody

class CrmConsentBody

What the guest chose in the host’s own screens about PurrCRM’s pushes. Only what is sent changes.

Members of CrmConsentBody

CrmConsentBody.fromJson()

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

CrmConsentBody()

const CrmConsentBody({bool? offersByPush})

offersByPush

final bool? offersByPush

The guest agreeing to offers by push, or null to leave it.

toJson

Map<String, Object?> toJson()

CrmDeviceBody

class CrmDeviceBody

The device the host’s Firebase gave a registration token for, which the package registers on every start and whenever the token changes.

Members of CrmDeviceBody

CrmDeviceBody.fromJson()

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

CrmDeviceBody()

const CrmDeviceBody({required String token, required CrmPushPlatform platform, String appVersion = '', String locale = ''})

appVersion

final String appVersion

What the app is and speaks, for staff to tell devices apart.

locale

final String locale

platform

final CrmPushPlatform platform

token

final String token

toJson

Map<String, Object?> toJson()

CrmExportDevice

class CrmExportDevice

One device the guest registered for pushes, in their export, without its token.

Members of CrmExportDevice

CrmExportDevice.fromJson()

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

CrmExportDevice()

const CrmExportDevice({required CrmPushPlatform platform, required DateTime createdAt, required DateTime lastSeenAt, String appVersion = '', String locale = ''})

appVersion

final String appVersion

createdAt

final DateTime createdAt

lastSeenAt

final DateTime lastSeenAt

locale

final String locale

platform

final CrmPushPlatform platform

CrmExportNotice

class CrmExportNotice

One notice in the guest’s inbox, in their export.

Members of CrmExportNotice

CrmExportNotice.fromJson()

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

CrmExportNotice()

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

body

final String body

createdAt

final DateTime createdAt

link

final String link

readAt

final DateTime? readAt

title

final String title

type

final String type

CrmForgetDeviceBody

class CrmForgetDeviceBody

The token the package registered, forgotten as the guest signs out so that the next guest on the phone is not pushed the last one’s.

Members of CrmForgetDeviceBody

CrmForgetDeviceBody.fromJson()

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

CrmForgetDeviceBody()

const CrmForgetDeviceBody({required String token})

token

final String token

toJson

Map<String, Object?> toJson()

CrmNoticePage

class CrmNoticePage

A page of the guest’s inbox, newest first.

Members of CrmNoticePage

CrmNoticePage.fromJson()

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

CrmNoticePage()

const CrmNoticePage({List<CrmNotice> notices = const <CrmNotice>[], int unread = 0, String nextBefore = ''})

nextBefore

final String nextBefore

The notice to ask for older ones before; empty on the last page.

notices

final List<CrmNotice> notices

unread

final int unread

The whole inbox’s unread count, not this page’s: the bell’s number.

CrmNoticesReadBody

class CrmNoticesReadBody

The notices the guest has seen, or all of them.

Members of CrmNoticesReadBody

CrmNoticesReadBody.fromJson()

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

CrmNoticesReadBody()

const CrmNoticesReadBody({List<String> ids = const <String>[], bool all = false})

all

final bool all

ids

final List<String> ids

toJson

Map<String, Object?> toJson()

crmDefaultNoticePage

const int crmDefaultNoticePage

A page of the inbox by default, and the most one page may be. The Go constants are DefaultNoticePage and MaxNoticePage.

crmMaxNoticePage

const int crmMaxNoticePage

No description.

crmMaxNoticesRead

const int crmMaxNoticesRead

The most notices one read may name. The Go constant is MaxNoticesRead.

crmMaxPushTokenBytes

const int crmMaxPushTokenBytes

The longest registration token PurrCRM keeps. The Go constant is MaxPushTokenBytes.