Introduce SpeziNotifications #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Supereg
commented
Sep 30, 2024
PSchmiedmayer
approved these changes
Oct 19, 2024
Sources/SpeziNotifications/SpeziNotifications.docc/SpeziNotifications.md
Outdated
Show resolved
Hide resolved
Supereg
added a commit
to StanfordSpezi/Spezi
that referenced
this pull request
Oct 28, 2024
…e some warnings (#117) # Provide integration points for SpeziNotifications, Swift 6 and silence some warnings ## ♻️ Current situation & Problem SpeziNotifications (StanfordSpezi/SpeziNotifications#1) is a new framework in the Spezi ecosystem that helps dealing with UserNotifications in your application. Some elements that are currently defined in Spezi are going to move to SpeziNotifications. We will fully move all of this infrastructure in a future breaking release of Spezi. For now, we make sure to have some of the required infrastructure accessible by SpeziNetworking. The `SpeziNotificationCenterDelegate` and associated protocols will stay for now but can eventually be fully moved to SpeziNotifications. For now, SpeziNotifications will re-export all relevant types so it is easier for users to be prepared for the change. ## ⚙️ Release Notes * Deprecated the remote notifications actions declared on Spezi. SpeziNotifications declares the exact same actions. * Allow SpeziNotifications to receive the delegate calls that are made after calling `registerForRemoteNotifications`. * Move the Package to the Swift 6 toolchain. * Silence some deprecation warnings through some visibility tricks. ## 📚 Documentation -- ## ✅ Testing -- ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
leej200100
pushed a commit
to leej200100/Spezi
that referenced
this pull request
Oct 30, 2024
…e some warnings (#117) # Provide integration points for SpeziNotifications, Swift 6 and silence some warnings ## ♻️ Current situation & Problem SpeziNotifications (StanfordSpezi/SpeziNotifications#1) is a new framework in the Spezi ecosystem that helps dealing with UserNotifications in your application. Some elements that are currently defined in Spezi are going to move to SpeziNotifications. We will fully move all of this infrastructure in a future breaking release of Spezi. For now, we make sure to have some of the required infrastructure accessible by SpeziNetworking. The `SpeziNotificationCenterDelegate` and associated protocols will stay for now but can eventually be fully moved to SpeziNotifications. For now, SpeziNotifications will re-export all relevant types so it is easier for users to be prepared for the change. ## ⚙️ Release Notes * Deprecated the remote notifications actions declared on Spezi. SpeziNotifications declares the exact same actions. * Allow SpeziNotifications to receive the delegate calls that are made after calling `registerForRemoteNotifications`. * Move the Package to the Swift 6 toolchain. * Silence some deprecation warnings through some visibility tricks. ## 📚 Documentation -- ## ✅ Testing -- ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce SpeziNotifications
♻️ Current situation & Problem
This PR marks the first release of the SpeziNotifications package. It introduces the
NotificationsModule and introduces two new actions:notificationSettingsto retrieve the current notification settings (e.g., authorization status) andrequestNotificationAuthorization. All notification related actions are accessible through the@Applicationproperty wrapper inside Spezi Modules and the@Environmentproperty wrapper inside SwiftUI Views. TheregisterRemoteNotificationsandunregisterRemoteNotificationsactions are now also available via the@Environmentproperty wrapper.Some infrastructure is still exported through Spezi (see StanfordSpezi/Spezi#117).
⚙️ Release Notes
Each target exposes a structured DocC documentation catalog and documents all public interfaces.
📚 Documentation
@Application(\.notificationSettings)and@Environment(\.notificationSettings)action to retrieve current notification settings like the authorization status.@Application(\.requestNotificationAuthorization)and@Environment(\. requestNotificationAuthorization)action to easily request notification authorization.Notificationsmodule that makes it easier to interact with notification related actions in Spezi application and ensures to silence concurrency warnings.XCTSpeziNotificationstarget to easily handle notification authorization alerts in UI tests.XCTSpeziNotificationsUItarget that can be used in UI test application to visualize pending notification requests.✅ Testing
Added extensive unit and UI testing for all components.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: