Shake to send a bug report!
Shake to send a bug report!
Maintained
BugShaker allows your QA team and/or end users to easily submit bug reports by shaking their device. When a shake is detected, the current screen state is captured and the user is prompted to submit a bug report via email with this screenshot attached.
This library is similar to Telescope, but aims to be even easier to integrate into your apps and workflows:
Application
subclass (no view hierarchy alterations required);Prompt | |
---|---|
https://play.google.com/store/apps/details?id=com.github.stkent.bugshaker
Specify BugShaker-Android as a dependency in your build.gradle file:
dependencies {
implementation("com.github.stkent:bugshaker:{latest-version}")
}
Configure the shared BugShaker
instance in your custom Application
class, then call assemble
and start
to begin listening for shakes:
public class CustomApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
BugShaker.get(this)
.setEmailAddresses("[email protected]") // required
.setEmailSubjectLine("Custom Subject Line") // optional
.setAlertDialogType(AlertDialogType.NATIVE) // optional
.setLoggingEnabled(BuildConfig.DEBUG) // optional
.setIgnoreFlagSecure(true) // optional
.assemble() // required
.start(); // required
}
}
It is recommended that logging always be disabled in production builds.
If you would like to customize the alert dialog presented to users when a shake is detected, update your BugShaker
configuration as follows:
setAlertDialogType
calls;setCustomDialogProvider
, passing in your own DialogProvider
instance.Copyright 2016 Stuart Kent
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.