Skip to content

Commit

Permalink
Merge branch 'release'
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaelsetragni committed Oct 2, 2023
2 parents f6b7dd4 + d961dc6 commit e789e4f
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 56 deletions.
4 changes: 2 additions & 2 deletions .dart_tool/package_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@
"languageVersion": "2.19"
}
],
"generated": "2023-09-27T02:54:47.294130Z",
"generated": "2023-10-02T15:24:13.746064Z",
"generator": "pub",
"generatorVersion": "3.1.2"
"generatorVersion": "3.1.3"
}
9 changes: 1 addition & 8 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## [0.8.0]
### Fixed
* Updated library versions to 0.8.0 to ensure that project lock files are updated.

## [0.7.7]
### Improved
* Enhanced versioning of iOS core libraries to better support DevOps, ensuring greater flexibility for future updates.
Expand Down
67 changes: 42 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,23 @@ We have made some changes to Awesome Notifications in version 0.7.X that may req

## Initial Configurations

Bellow are the obligatory configurations that your app must meet to use awesome_notifications:
To use the `awesome_notifications`, follow these steps:

1. Add the `awesome_notifications` plugin to your project's `pubspec.yaml` file:

```yaml
dependencies:
awesome_notifications_core: ^0.8.0 # <~ always ensure to use the latest version
awesome_notifications: any # <~ this version is managed by awesome_notifications_core package
```
After adding the dependency, run the following command to get the package:
```bash
flutter pub get
```

Now you need to modify some files in native libraries to meet to use awesome_notifications properly. Let's start with the Android configurations:

<br>

Expand All @@ -256,7 +272,7 @@ buildscript {
...
dependencies {
classpath 'com.android.tools.build:gradle:7.2.2'
classpath 'com.android.tools.build:gradle:7.3.0'
}
}
Expand Down Expand Up @@ -969,29 +985,30 @@ You can use the following attributes to configure your notification channels:

## Notification Channel Attributes

| Attribute | Required | Description | Type | Updatable | Default Value |
| ----------------------| -------- | -------------------------------------------------------------------------------------------- | ---------------------- | --------- | ------------- |
| `channelKey` | Yes | A string key that identifies a channel where notifications are sent. | String | No | basic_channel |
| `channelName` | Yes | The name of the channel, which is visible to users on Android. | String | Yes | None |
| `channelDescription` | Yes | A brief description of the channel, which is visible to users on Android. | String | Yes | None |
| `channelShowBadge` | No | Whether the notification should automatically increment the app icon badge counter. | Boolean | Yes | `false` |
| `importance` | No | The importance level of the notification. | NotificationImportance | No | `Normal` |
| `playSound` | No | Whether the notification should play a sound. | Boolean | No | `true` |
| `soundSource` | No | The path of a custom sound file to be played with the notification. | String | No | None |
| `defaultRingtoneType` | No | The type of default sound to be played with the notification (only for Android). | DefaultRingtoneType | Yes | `Notification`|
| `enableVibration` | No | Whether the device should vibrate when the notification is received. | Boolean | No | `true` |
| `enableLights` | No | Whether the device should display a blinking LED when the notification is received. | Boolean | No | `true` |
| `ledColor` | No | The color of the LED to display when the notification is received. | Color | No | `Colors.white`|
| `ledOnMs` | No | The duration in milliseconds that the LED should remain on when displaying the notification. | Integer | No | None |
| `ledOffMs` | No | The duration in milliseconds that the LED should remain off when displaying the notification.| Integer | No | None |
| `groupKey` | No | The string key used to group notifications together. | String | No | None |
| `groupSort` | No | The order in which notifications within a group should be sorted. | GroupSort | No | `Desc` |
| `groupAlertBehavior` | No | The alert behavior to use for notifications within a group. | GroupAlertBehavior | No | `All` |
| `defaultPrivacy` | No | The level of privacy to apply to the notification when the device is locked. | NotificationPrivacy | No | `Private` |
| `icon` | No | The name of the notification icon to display in the status bar. | String | No | None |
| `defaultColor` | No | The color to use for the notification on Android. | Color | No | `Color.black` |
| `locked` | No | Whether the notification should be prevented from being dismissed by the user. | Boolean | No | `false` |
| `onlyAlertOnce` | No | Whether the notification should only alert the user once. | Boolean | No | `false` |
| Attribute | Required | Description | Type | Updatable | Default Value |
|-----------------------| -------- |-----------------------------------------------------------------------------------------------|-------------------------|-----------|----------------|
| `channelKey` | Yes | A string key that identifies a channel where notifications are sent. | String | No | basic_channel |
| `channelName` | Yes | The name of the channel, which is visible to users on Android. | String | Yes | None |
| `channelDescription` | Yes | A brief description of the channel, which is visible to users on Android. | String | Yes | None |
| `channelShowBadge` | No | Whether the notification should automatically increment the app icon badge counter. | Boolean | Yes | `false` |
| `channelGroupKey` | No | A string key to group all channels in same topic at android's configuration page | String | No | None |
| `importance` | No | The importance level of the notification. | NotificationImportance | No | `Normal` |
| `playSound` | No | Whether the notification should play a sound. | Boolean | No | `true` |
| `soundSource` | No | The path of a custom sound file to be played with the notification. | String | No | None |
| `defaultRingtoneType` | No | The type of default sound to be played with the notification (only for Android). | DefaultRingtoneType | Yes | `Notification` |
| `enableVibration` | No | Whether the device should vibrate when the notification is received. | Boolean | No | `true` |
| `enableLights` | No | Whether the device should display a blinking LED when the notification is received. | Boolean | No | `true` |
| `ledColor` | No | The color of the LED to display when the notification is received. | Color | No | `Colors.white` |
| `ledOnMs` | No | The duration in milliseconds that the LED should remain on when displaying the notification. | Integer | No | None |
| `ledOffMs` | No | The duration in milliseconds that the LED should remain off when displaying the notification. | Integer | No | None |
| `groupKey` | No | The string key used to group notifications together in Android status bar. | String | No | None |
| `groupSort` | No | The order in which notifications within a group should be sorted. | GroupSort | No | `Desc` |
| `groupAlertBehavior` | No | The alert behavior to use for notifications within a group. | GroupAlertBehavior | No | `All` |
| `defaultPrivacy` | No | The level of privacy to apply to the notification when the device is locked. | NotificationPrivacy | No | `Private` |
| `icon` | No | The name of the notification icon to display in the status bar. | String | No | None |
| `defaultColor` | No | The color to use for the notification on Android. | Color | No | `Color.black` |
| `locked` | No | Whether the notification should be prevented from being dismissed by the user. | Boolean | No | `false` |
| `onlyAlertOnce` | No | Whether the notification should only alert the user once. | Boolean | No | `false` |


<br>
Expand Down
26 changes: 13 additions & 13 deletions android/build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
group 'me.carda.awesome_notifications'
version '0.7.5'
version '0.8.0'

buildscript {
repositories {
Expand Down Expand Up @@ -43,21 +43,21 @@ android {

dependencies {
// implementation project(':awn_core')
implementation 'me.carda:AndroidAwnCore:0.7.6'
implementation 'me.carda:AndroidAwnCore:[0.8.0, 0.9.0)'

implementation 'com.google.guava:guava:31.1-android'

// Required for instrumented tests
testImplementation 'junit:junit:4.13.2'
testImplementation 'androidx.arch.core:core-testing:2.1.0'
testImplementation 'org.mockito:mockito-core:4.8.0'
testImplementation 'org.mockito:mockito-inline:4.7.0'

androidTestImplementation 'androidx.annotation:annotation:1.5.0'
androidTestImplementation 'org.mockito:mockito-core:4.8.0'
androidTestImplementation 'org.mockito:mockito-inline:4.7.0'
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
androidTestImplementation 'androidx.test:runner:1.4.0'
androidTestImplementation 'androidx.test:core:1.4.0'
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
testImplementation 'androidx.arch.core:core-testing:2.2.0'
testImplementation 'org.mockito:mockito-core:5.1.1'
testImplementation 'org.mockito:mockito-inline:5.0.0'

androidTestImplementation 'androidx.annotation:annotation:1.7.0'
androidTestImplementation 'org.mockito:mockito-core:5.1.1'
androidTestImplementation 'org.mockito:mockito-inline:5.0.0'
androidTestImplementation 'androidx.test.ext:junit:1.1.5'
androidTestImplementation 'androidx.test:runner:1.5.2'
androidTestImplementation 'androidx.test:core:1.5.0'
androidTestImplementation 'androidx.test.ext:junit:1.1.5'
}
10 changes: 5 additions & 5 deletions example/ios/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
PODS:
- awesome_notifications (0.7.6):
- awesome_notifications (0.8.0):
- Flutter
- IosAwnCore (~> 0.7.6)
- IosAwnCore (~> 0.8.0)
- device_info_plus (0.0.1):
- Flutter
- Flutter (1.0.0)
- fluttertoast (0.0.2):
- Flutter
- Toast
- IosAwnCore (0.7.6)
- IosAwnCore (0.8.0)
- path_provider_foundation (0.0.1):
- Flutter
- FlutterMacOS
Expand Down Expand Up @@ -55,11 +55,11 @@ EXTERNAL SOURCES:
:path: ".symlinks/plugins/vibration/ios"

SPEC CHECKSUMS:
awesome_notifications: ed4a1fc51472a08eb14849d03ba0b27dd170e7a2
awesome_notifications: 46bcb1072a613878e97f0f67478f82669b9a1623
device_info_plus: 7545d84d8d1b896cb16a4ff98c19f07ec4b298ea
Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
fluttertoast: 31b00dabfa7fb7bacd9e7dbee580d7a2ff4bf265
IosAwnCore: c5106760789f03b35823c3bb427a4698ec59aa47
IosAwnCore: ed1b2b6d84962a758354dbacd9ce525c72ce28a9
path_provider_foundation: 29f094ae23ebbca9d3d0cec13889cd9060c0e943
shared_preferences_foundation: e2dae3258e06f44cc55f49d42024fd8dd03c590c
Toast: 91b396c56ee72a5790816f40d3a94dd357abc196
Expand Down
4 changes: 2 additions & 2 deletions ios/awesome_notifications.podspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'awesome_notifications'
s.version = '0.7.6'
s.version = '0.8.0'
s.summary = 'A complete solution to create Local and Push Notifications, through Firebase or another services, using Flutter.'
s.description = <<-DESC
A complete solution to create Local Notifications and Push Notifications, through Firebase or another services, using Flutter.
Expand All @@ -12,7 +12,7 @@ A complete solution to create Local Notifications and Push Notifications, throug
s.source_files = 'Classes/**/*'
s.static_framework = true
s.dependency 'Flutter'
s.dependency 'IosAwnCore', '~> 0.7.6'
s.dependency 'IosAwnCore', '~> 0.8.0'
s.platform = :ios, '11.0'

# Flutter.framework does not contain a i386 slice. Only x86_64 simulators are supported.
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: awesome_notifications
description: A complete solution to create Local and Push Notifications, customizing buttons, images, sounds, emoticons and applying many different layouts for Flutter apps.
version: 0.7.7
version: 0.8.0
repository: https://github.com/rafaelsetragni/awesome_notifications

environment:
Expand Down

0 comments on commit e789e4f

Please sign in to comment.