Locally class - locally library

Constructors

Locally({required BuildContext context, required MaterialPageRoute pageRoute, required String appIcon, required String payload, bool iosRequestSoundPermission = false, bool iosRequestBadgePermission = false, bool iosRequestAlertPermission = false}): Then we create a construct of Locally which required a context, pageRoute, appIcon and a payload It also received ios Parameters which are still in dev Within the construct, localNotification settings is initialized with Flutter Local Notification Setting declared above

Properties

appIcon ↔ String: App Icon which is required on initialization
getter/setter pair
context ↔ BuildContext: A context is also required
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
initializationSetting ↔ dynamic: getter/setter pair
initializationSettingAndroid ↔ dynamic: getter/setter pair
initializationSettingIos ↔ dynamic: getter/setter pair
iosRequestAlertPermission ↔ bool: getter/setter pair
iosRequestBadgePermission ↔ bool: getter/setter pair
iosRequestSoundPermission ↔ bool: IOS Parameters, this is currently not in use but will be implemented in future releases
getter/setter pair
key ↔ Key?: A key identifier property is needed
getter/setter pair
localNotificationsPlugin ↔ FlutterLocalNotificationsPlugin: local notification initialization initializationSettingAndroid initializationSettingIos; initializationSetting;
getter/setter pair
message ↔ String: A String message
getter/setter pair
pageRoute ↔ MaterialPageRoute: Page Route which is also required on Initialization
getter/setter pair
payload ↔ String: Payload for Navigation
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
title ↔ String: A String title for Notification
getter/setter pair

Methods

cancel(int index) → Future: The cancel method as the name goes cancels a with a provided index id
cancelAll() → Future: The cancelAll method as the name goes cancels all pending notification
getDetailsIfAppWasLaunchedViaNotification() → Future: The getDetailsIfAppWasLaunchedViaNotification return details if the app was lauched by a notification payload
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onDidReceiveNotification(dynamic id, dynamic title, dynamic body, dynamic payload) → Future<void>: onDidReceiveNotification it required for IOS initialization it takes in id, title, body and payload
onSelectNotification(String? payload) → Future: onSelectNotification Obtains a string payload And perform navigation function
requestPermission() → Future: requestPermission() for IOS developers only
retrievePendingNotifications() → Future: The retrievePendingNotifications return all pending notification to the screen
schedule({required dynamic title, required dynamic message, dynamic channelName = 'channel Name', dynamic channelID = 'channelID', dynamic channelDescription = 'channel Description', dynamic importance = Importance.high, dynamic priority = Priority.high, dynamic ticker = 'test ticker', required Duration duration, dynamic androidAllowWhileIdle = false}) → Future: The scheduleMethod return a notification to the screen But with this you can schedule a messag to show at a given time it takes in a required title, message channel Name, channel ID, channel Description, importance, priority ticker and a Duration class
show({required dynamic title, required dynamic message, dynamic channelName = 'channel Name', dynamic channelID = 'channelID', dynamic channelDescription = 'channel Description', dynamic importance = Importance.high, dynamic priority = Priority.high, dynamic ticker = 'test ticker'}) → Future: The show Method return a notification to the screen it takes in a required title, message channel Name, channel ID, channel Description, importance, priority ticker
showDailyAtTime({required dynamic title, required dynamic message, dynamic channelName = 'channel Name', dynamic channelID = 'channelID', dynamic channelDescription = 'channel Description', dynamic importance = Importance.high, dynamic priority = Priority.high, dynamic ticker = 'test ticker', required dynamic time, bool suffixTime = false}) → Future: The showDailyAtTime return a notification to the screen But with this you can decide to show a message at a given time in the day it takes in a required title, message channel Name, channel ID, channel Description, importance, priority ticker and a time
showPeriodically({required dynamic title, required dynamic message, dynamic channelName = 'channel Name', dynamic channelID = 'channelID', dynamic channelDescription = 'channel Description', dynamic importance = Importance.high, dynamic priority = Priority.high, required dynamic repeatInterval, dynamic ticker = 'test ticker'}) → Future: The showPeriodicallyd return a notification to the screen But with this you can repeat a message to show at a given interval it takes in a required title, message channel Name, channel ID, channel Description, importance, priority ticker and a repeat interval
showWeeklyAtDayAndTime({required dynamic title, required dynamic message, dynamic channelName = 'channel Name', dynamic channelID = 'channelID', dynamic channelDescription = 'channel Description', Importance importance = Importance.high, Priority priority = Priority.high, dynamic ticker = 'test ticker', dynamic time, dynamic day, bool suffixTime = false}) → Future: The showWeeklyAtDayAndTime return a notification to the screen But with this you can decide to show a message at a given day of the week and at a given time it takes in a required title, message channel Name, channel ID, channel Description, importance, priority ticker and a time and Day
toString() → String: A string representation of this object.
inherited

Operators

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