Courier class

Inheritance

• Object
• PlatformInterface
• CourierChannelManager
• Courier

Properties

apnsToken → Future<String?>

no setter, override

archivedMessages → Future<List<InboxMessage>>

no setter, inherited

client → Future<CourierClient?>

no setter, override

fcmToken → Future<String?>

no setter, override

feedMessages → Future<List<InboxMessage>>

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

inboxPaginationLimit → Future<int>

no setter, override

isUITestsActive ↔ bool

getter/setter pair, inherited

isUserSignedIn → Future<bool>

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tenantId → Future<String?>

no setter, override

tokens → Future<Map<String, String>>

no setter, override

userId → Future<String?>

no setter, override

Methods

addAuthenticationListener(dynamic onUserStateChanged(String? userId)) → Future<CourierAuthenticationListener>

override

addInboxListener({dynamic onLoading(bool isRefresh)?, dynamic onError(String error)?, dynamic onUnreadCountChanged(int unreadCount)?, dynamic onTotalCountChanged(InboxFeed feed, int totalCount)?, dynamic onMessagesChanged(List<InboxMessage> messages, bool canPaginate, InboxFeed feed)?, dynamic onPageAdded(List<InboxMessage> messages, bool canPaginate, bool isFirstPage, InboxFeed feed)?, dynamic onMessageEvent(InboxMessage message, int index, InboxFeed feed, InboxMessageEvent event)?}) → Future<CourierInboxListener>

override

addPushListener({required dynamic onPushDelivered(dynamic message)?, dynamic onPushClicked(dynamic message)?}) → Future<CourierPushListener>

override

archiveMessage({required String messageId}) → Future

override

clickMessage({required String messageId}) → Future

override

fetchNextInboxPage({required InboxFeed feed}) → Future<InboxMessageSet?>

override

getToken({required String provider}) → Future<String?>

override

getTokenForProvider({required CourierPushProvider provider}) → Future<String?>

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openMessage({required String messageId}) → Future

override

readAllInboxMessages() → Future

override

readMessage({required String messageId}) → Future

override

refreshInbox() → Future

Because the native code no longer provides "inbox.get_feed_messages" or "inbox.get_archived_messages", we remove those calls. The user is expected to rely on the "inbox.listener_messages_changed" callback and/or the incremental fetch "fetchNextInboxPage()" below.

override

removeAllAuthenticationListeners() → Future

override

removeAllInboxListeners() → Future

override

removeAllPushListeners() → void

override

removeAuthenticationListener({required String listenerId}) → Future

override

removeInboxListener({required String listenerId}) → Future

override

removePushListener({required String listenerId}) → void

override

setInboxPaginationLimit({required int limit}) → Future

override

setToken({required String token, required String provider}) → Future

override

setTokenForProvider({required String token, required CourierPushProvider provider}) → Future

override

signIn({required String userId, required String accessToken, String? clientKey, String? tenantId, bool? showLogs}) → Future

override

signOut() → Future

override

toString() → String

A string representation of this object.

inherited

unreadMessage({required String messageId}) → Future

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

iOSForegroundNotificationPresentationOptions → List<iOSNotificationPresentationOption>

no setter

shared → Courier

no setter

Static Methods

getClickedNotification() → Future

getNotificationPermissionStatus() → Future<String>

log(String message) → void

openSettingsApp() → Future

requestNotificationPermission() → Future<String>

setIOSForegroundPresentationOptions({required List<iOSNotificationPresentationOption> options}) → Future<List<iOSNotificationPresentationOption>>