-
Notifications
You must be signed in to change notification settings - Fork 109
Example of auto notification tracking #63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // | ||
| // NotificationTracking.swift | ||
| // | ||
| // Created by Brandon Sneed on 9/17/21. | ||
| // | ||
|
|
||
| // NOTE: You can see this plugin in use in the SwiftUIKitExample application. | ||
| // | ||
| // This plugin is NOT SUPPORTED by Segment. It is here merely as an example, | ||
| // and for your convenience should you find it useful. | ||
|
|
||
| // MIT License | ||
| // | ||
| // Copyright (c) 2021 Segment | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| // MARK: Common | ||
|
|
||
| #if !os(Linux) && !os(macOS) | ||
|
|
||
| import Foundation | ||
| import Segment | ||
|
|
||
| class NotificationTracking: Plugin { | ||
| var type: PluginType = .utility | ||
| var analytics: Analytics? | ||
|
|
||
| func trackNotification(_ properties: [String: Any], fromLaunch launch: Bool) { | ||
| if launch { | ||
| analytics?.track(name: "Push Notification Tapped", properties: properties) | ||
| } else { | ||
| analytics?.track(name: "Push Notification Received", properties: properties) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // NOTE: watchOS doesn't have the concept of launch options for making a | ||
| // determination if a push notification caused the app to open. | ||
| extension NotificationTracking: RemoteNotifications { | ||
| func receivedRemoteNotification(userInfo: [AnyHashable: Any]) { | ||
| if let notification = userInfo as? [String: Any] { | ||
| trackNotification(notification, fromLaunch: false) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
|
|
||
| // MARK: macOS -- TODO: Full lifecycle/delegation options in library. | ||
| /* | ||
| #if os(macOS) | ||
|
|
||
| import Cocoa | ||
|
|
||
| extension NotificationTracking: macOSLifecycle { | ||
| func application(didFinishLaunchingWithOptions launchOptions: [String: Any]?) { | ||
| if let notification = launchOptions?[NSApplication.launchUserNotificationUserInfoKey] as? [String: Any] { | ||
| trackNotification(notification, fromLaunch: true) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
| */ | ||
|
|
||
| // MARK: iOS/tvOS/Catalyst | ||
|
|
||
| #if os(tvOS) || os(iOS) || targetEnvironment(macCatalyst) | ||
|
|
||
| import UIKit | ||
|
|
||
| extension NotificationTracking: iOSLifecycle { | ||
| func application(_ application: UIApplication?, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) { | ||
| if let notification = launchOptions?[UIApplication.LaunchOptionsKey.remoteNotification] as? [String: Any] { | ||
| trackNotification(notification, fromLaunch: true) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
|
|
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,8 @@ | |
| import Foundation | ||
| import UIKit | ||
|
|
||
| // NOTE: These method signatures are marked optional as application extensions may not have | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍🏻 |
||
| // a UIApplication object available. See `safeShared` below. | ||
| public protocol iOSLifecycle { | ||
| func applicationDidEnterBackground(application: UIApplication?) | ||
| func applicationWillEnterForeground(application: UIApplication?) | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maybe add a comment:
// Uncomment to add notification tracking to your appor something?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a placeholder until I get full lifecycle stuff on Mac working.