PushNotificationBloc class - push_notification_bloc library

Constructors

PushNotificationBloc(): Push notification BLoC for handling push notifications.

Properties

hashCode → int: The hash code for this object.
no setterinherited
isClosed → bool: Whether the bloc is closed.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → PushNotificationState: The current state.
no setterinherited
stream → Stream<PushNotificationState>: The current stream of states.
no setterinherited

Methods

add(PushNotificationEvent event) → void: Notifies the Bloc of a new event which triggers all corresponding EventHandler instances.
inherited
addError(Object error, [StackTrace? stackTrace]) → void: Reports an error which triggers onError with an optional StackTrace.
inherited
close() → Future<void>: Closes the event and state Streams. This method should be called when a Bloc is no longer needed. Once close is called, events that are added will not be processed. In addition, if close is called while events are still being processed, the Bloc will finish processing the pending events.
inherited
dispose() → dynamic: Dispose push notification BLoC
emit(PushNotificationState state) → void: emit is only for internal use and should never be called directly outside of tests. The Emitter instance provided to each EventHandler should be used instead.
inherited
hasNotificationPermission() → Future<bool>: Check if the app already has notification permission.
initializeNotifications({required String appId, String? channelName}) → Future<void>: Initialize push notifications (with default channel for Android).
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
on<E extends Event>(EventHandler<E, PushNotificationState> handler, {EventTransformer<E>? transformer}) → void: Register event handler for an event of type E. There should only ever be one event handler per event type E.
inherited
onChange(Change<PushNotificationState> change) → void: Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.
inherited
onDispose() → FutureOr: override
onError(Object error, StackTrace stackTrace) → void: Called whenever an error occurs and notifies BlocObserver.onError.
inherited
onEvent(PushNotificationEvent event) → void: Called whenever an event is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.
inherited
onTransition(Transition<PushNotificationEvent, PushNotificationState> transition) → void: Called whenever a transition occurs with the given transition. A transition occurs when a new event is added and a new state is emitted from a corresponding EventHandler.
inherited
registerDeviceToken() → Future<void>: Register device token for notifications.
requestNotificationPermission() → Future<bool>: Request notification permission on the corresponding platform.
requiresNotificationPermission() → Future<bool>: Check if the app requires notification permission (Android 13+ or iOS).
setBackgroundMessageHandler(Future<void> handler(RemoteMessage message)) → void: Specify background message handler
setForegroundMessageHandler() → void: Specify foreground message handler
setNotificationOpenAppHandler() → void: Specify notification open app handler
toString() → String: A string representation of this object.
inherited
unregisterDeviceToken() → Future<void>: Unregister device token for notifications.

Operators

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