PushNotificationsCategory class
- Inheritance
-
- Object
- AmplifyCategory<
PushNotificationsPluginInterface> - PushNotificationsCategory
Constructors
Properties
- category → Category
-
no setteroverride
-
categoryDependencies
→ Set<
Category> -
The categories this category depends on.
no setteroverride
- defaultPlugin → PushNotificationsPluginInterface
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- launchNotification → PushNotificationMessage?
-
Returns a PushNotificationMessage or null depending on what action launched the app.
no setter
-
onNotificationOpened
→ Stream<
PushNotificationMessage> -
Will emit the
PushNotificationMessagethat an end user has tapped on to open the App.no setter -
onNotificationReceivedInForeground
→ Stream<
PushNotificationMessage> -
Will emit a
PushNotificationMessageas the device receives them when the App is in the foreground.no setter -
onTokenReceived
→ Stream<
String> -
Listen to new Device tokens generated by FCM and APNS
no setter
-
plugins
→ List<
PushNotificationsPluginInterface> -
The plugins registered for this category.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addPlugin(
PushNotificationsPluginInterface plugin, {required AmplifyAuthProviderRepository authProviderRepo}) → Future< void> -
Adds a plugin to the category.
inherited
-
getBadgeCount(
) → Future< int> - Returns the current number displayed in the app icon badge.
-
getPermissionStatus(
) → Future< PushNotificationPermissionStatus> - The current Push Notificaiton permission state.
-
identifyUser(
{required String userId, UserProfile? userProfile}) → Future< void> - Associate the given user information with the current device.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onNotificationReceivedInBackground(
OnRemoteMessageCallback callback) → void - Register an OnRemoteMessageCallback to be called when the device receives push notification and the App is in the background.
-
requestPermissions(
{bool alert = true, bool badge = true, bool sound = true}) → Future< bool> - Request push notifications permissions with options.
-
reset(
) → Future< void> -
Resets the category, clearing all registered plugins.
inherited
-
setBadgeCount(
int badgeCount) → void -
Sets
badgeCountas the number displayed in the App icon badge. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited