FirePushNotificationsConfig class

Constructors

FirePushNotificationsConfig({required Uri registerDeviceTokenApiEndpoint(Map<String, dynamic>? params), required Uri removeDeviceTokenApiEndpoint(PushTokenRegisterInfo info, Map<String, dynamic>? params), bool shouldDismissNotification(Map<String, dynamic> data)?, BaseRequest registerDeviceRequestMapper(Request request, PushTokenRegisterInfo info, Map<String, dynamic>? params)?, PushNotificationMetadataMapper? metadataMapper, BaseRequest removeDeviceRequestMapper(Request request, PushTokenRegisterInfo info, Map<String, dynamic>? params)?, Future<void> onBackgroundNotification(RemoteMessage)?, String? vapidKey})

Properties

hashCode int
The hash code for this object.
no setterinherited
metadataMapper PushNotificationMetadataMapper?
Provide a custom function to utilize in order to map your custom Metadata
final
onBackgroundNotification Future<void> Function(RemoteMessage)?
Provide a top-level, non-anonymous function to handle background Notifications
final
registerDeviceRequestMapper → BaseRequest Function(Request request, PushTokenRegisterInfo info, Map<String, dynamic>? params)?
Provide a custom request mapper to customize payload send to registerDeviceTokenApiEndpoint it provides you access to original built request, the device token info and the custom params if defined
final
registerDeviceTokenApiEndpoint Uri Function(Map<String, dynamic>? params)
Provides an endpoint to be used when trying to register device push token
final
removeDeviceRequestMapper → BaseRequest Function(Request request, PushTokenRegisterInfo info, Map<String, dynamic>? params)?
Provide a custom request mapper to customize payload send to removeDeviceTokenApiEndpoint it provides you access to original built request, the device token info and the custom params if defined
final
removeDeviceTokenApiEndpoint Uri Function(PushTokenRegisterInfo info, Map<String, dynamic>? params)
Provides an endpoint to be used when trying to remove device push token params can be customized via custom FirePushNotificationsBloc or FirePushNotificationsProvider(config)
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldDismissNotification bool Function(Map<String, dynamic> data)?
Provide a callback to be used to test if the received notification should be dismissed This is helpful if you are integrating 3rd party SDKs that also send notifications to the app
final
vapidKey String?
Provide VAPID Key if using on web
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited