Prepare 2.0.1 release

Author: 05nelsonm

docs/changelog.md

@@ -1,11 +1,19 @@
 # Change Log
 
+## Version 2.0.1 (2020-10-18)
+ - Deprecates the `ServiceNotification.Builder.setActivityToBeOpenedOnTap` method in favor of using
+ the new `ServiceNotification.Builder.setContentIntentData` to mitigate multiple activities from
+ being opened.
+
 ## Version 2.0.0 (2020-10-18)
  - Adds support for Version 3 Hidden Service Client Authentication
      - The `V3ClientAuthManager` class can be obtained from `TorServiceController.getV3ClientAuthManager`
      after Builder initialization, which facilitates easily adding private keys to Tor's `ClientAuthDir`.
  - Adds better support for multi-module projects by moving `topl-service`'s public
  classes/abstractions to a separate module, `topl-service-base`.
+ - TorService now broadcasts as a `NOTICE` via the EventBroadcasters when onTaskRemoved occurred,
+ instead of being broadcast as `DEBUG` (which required TorSettings.hasDebugLogs to be set to true).
+     - Can now listen for it in the implementing application's `TorServiceEventBroadcaster`.
  - See [Migrations](./migration.md) for details on how to migrate from `1.0.0` to `2.0.0`
 
 ## Version 1.0.0-beta02 (2020-10-08)

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/-init-.md

@@ -19,12 +19,9 @@ in order to properly shut down Tor and clean up w/o being killed by the OS.
             channelID = "TOPL-Android Demo",
             notificationID = 615
         )
-            .setActivityToBeOpenedOnTap(
-                clazz = MainActivity::class.java,
-                intentExtrasKey = null,
-                intentExtras = null,
-                intentRequestCode = null
-            )
+            // Only needed if you are passing a bundle, or changing request code to something other than 0
+            .setContentIntentData(bundle = null, requestCode = 21)
+
             .setImageTorNetworkingEnabled(drawableRes = R.drawable.tor_stat_network_enabled)
             .setImageTorNetworkingDisabled(drawableRes = R.drawable.tor_stat_network_disabled)
             .setImageTorDataTransfer(drawableRes = R.drawable.tor_stat_network_dataxfer)

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/enable-tor-restart-button.md

@@ -2,7 +2,7 @@
 
 # enableTorRestartButton
 
-`@JvmOverloads fun enableTorRestartButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L300)
+`@JvmOverloads fun enableTorRestartButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L327)
 
 Disabled by Default
 

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/enable-tor-stop-button.md

@@ -2,7 +2,7 @@
 
 # enableTorStopButton
 
-`@JvmOverloads fun enableTorStopButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L317)
+`@JvmOverloads fun enableTorStopButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L344)
 
 Disabled by Default
 

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/index.md

@@ -2,7 +2,7 @@
 
 # Builder
 
-`class Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L144)
+`class Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L146)
 
 Where you get to customize how your notification will look and function.
 
@@ -19,12 +19,9 @@ in order to properly shut down Tor and clean up w/o being killed by the OS.
             channelID = "TOPL-Android Demo",
             notificationID = 615
         )
-            .setActivityToBeOpenedOnTap(
-                clazz = MainActivity::class.java,
-                intentExtrasKey = null,
-                intentExtras = null,
-                intentRequestCode = null
-            )
+            // Only needed if you are passing a bundle, or changing request code to something other than 0
+            .setContentIntentData(bundle = null, requestCode = 21)
+
             .setImageTorNetworkingEnabled(drawableRes = R.drawable.tor_stat_network_enabled)
             .setImageTorNetworkingDisabled(drawableRes = R.drawable.tor_stat_network_disabled)
             .setImageTorDataTransfer(drawableRes = R.drawable.tor_stat_network_dataxfer)
@@ -63,7 +60,8 @@ in order to properly shut down Tor and clean up w/o being killed by the OS.
 |---|---|
 | [enableTorRestartButton](enable-tor-restart-button.md) | Disabled by Default`fun enableTorRestartButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` |
 | [enableTorStopButton](enable-tor-stop-button.md) | Disabled by Default`fun enableTorStopButton(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): Builder` |
-| [setActivityToBeOpenedOnTap](set-activity-to-be-opened-on-tap.md) | Define the Activity to be opened when your user taps TorService's notification.`fun setActivityToBeOpenedOnTap(clazz: `[`Class`](https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>, intentExtrasKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentExtras: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentRequestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` |
+| [setActivityToBeOpenedOnTap](set-activity-to-be-opened-on-tap.md) | Define the Activity to be opened when your user taps TorService's notification.`fun ~~setActivityToBeOpenedOnTap~~(clazz: `[`Class`](https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>, intentExtrasKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentExtras: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentRequestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` |
+| [setContentIntentData](set-content-intent-data.md) | Default notification behaviour is to use the launch intent for your application from Package Manager when a user taps the notification. Electing this method allows for adding a request code and bundle to the PendingIntent.`fun setContentIntentData(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?, requestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` |
 | [setCustomColor](set-custom-color.md) | Defaults to [R.color.tor_service_white](#)`fun setCustomColor(colorRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` |
 | [setImageTorDataTransfer](set-image-tor-data-transfer.md) | Defaults to Orbot/TorBrowser's icon [R.drawable.tor_stat_network_dataxfer](#).`fun setImageTorDataTransfer(drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` |
 | [setImageTorErrors](set-image-tor-errors.md) | Defaults to Orbot/TorBrowser's icon [R.drawable.tor_stat_notifyerr](#).`fun setImageTorErrors(drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` |

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/set-activity-to-be-opened-on-tap.md

@@ -2,7 +2,8 @@
 
 # setActivityToBeOpenedOnTap
 
-`fun setActivityToBeOpenedOnTap(clazz: `[`Class`](https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>, intentExtrasKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentExtras: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentRequestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L180)
+`fun ~~setActivityToBeOpenedOnTap~~(clazz: `[`Class`](https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>, intentExtrasKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentExtras: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, intentRequestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L182)
+**Deprecated:** Default behavior of user tapping notification now uses your application's launcher intent from package manager to mitigate launching of multiple activities.
 
 Define the Activity to be opened when your user taps TorService's notification.
 
@@ -16,15 +17,4 @@ See [Builder](index.md) for code samples.
 
 `intentExtras` - ? The extras that will be sent in the PendingIntent.
 
-`intentRequestCode` -
-
-? The request code - Defaults to 0 if not set.
-
-
-
-TODO:
-
-
-* Include an optional Bundle? to be set for creating the pending intent.
-* Think about overriding and providing another option to rotate the ContentIntent
-to open up/resume current activity?
+`intentRequestCode` - ? The request code - Defaults to 0 if not set.

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/set-content-intent-data.md

@@ -0,0 +1,22 @@
+[topl-service](../../../index.md) / [io.matthewnelson.topl_service.notification](../../index.md) / [ServiceNotification](../index.md) / [Builder](index.md) / [setContentIntentData](./set-content-intent-data.md)
+
+# setContentIntentData
+
+`fun setContentIntentData(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?, requestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L211)
+
+Default notification behaviour is to use the launch intent for your application
+from Package Manager when a user taps the notification. Electing this method allows
+for adding a request code and bundle to the PendingIntent.
+
+**NOTE:** electing [setActivityToBeOpenedOnTap](set-activity-to-be-opened-on-tap.md) method behaviour takes precedent until
+it is removed in a future release.
+
+**NOTE:** If you do not elect this method or [setActivityToBeOpenedOnTap](set-activity-to-be-opened-on-tap.md) in your
+[Builder](index.md), the notification's content intent is still set with a default [requestCode](set-content-intent-data.md#io.matthewnelson.topl_service.notification.ServiceNotification.Builder$setContentIntentData(android.os.Bundle, kotlin.Int)/requestCode)
+value of 0 and null bundle.
+
+### Parameters
+
+`bundle` - Bundle to be sent to the Launch Activity
+
+`requestCode` - Request Code to be used when launching the Activity

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/set-custom-color.md

@@ -2,7 +2,7 @@
 
 # setCustomColor
 
-`fun setCustomColor(@ColorRes colorRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L266)
+`fun setCustomColor(@ColorRes colorRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L293)
 
 Defaults to [R.color.tor_service_white](#)
 

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/set-image-tor-data-transfer.md

@@ -2,7 +2,7 @@
 
 # setImageTorDataTransfer
 
-`fun setImageTorDataTransfer(@DrawableRes drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L235)
+`fun setImageTorDataTransfer(@DrawableRes drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L262)
 
 Defaults to Orbot/TorBrowser's icon [R.drawable.tor_stat_network_dataxfer](#).
 

docs/topl-service/io.matthewnelson.topl_service.notification/-service-notification/-builder/set-image-tor-errors.md

@@ -2,7 +2,7 @@
 
 # setImageTorErrors
 
-`fun setImageTorErrors(@DrawableRes drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L250)
+`fun setImageTorErrors(@DrawableRes drawableRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Builder` [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-service/src/main/java/io/matthewnelson/topl_service/notification/ServiceNotification.kt#L277)
 
 Defaults to Orbot/TorBrowser's icon [R.drawable.tor_stat_notifyerr](#).