Reactive Android App Permissions API with delegates and logging
Switch branches/tags
Clone or download
Latest commit d4fa31e Nov 13, 2018

README.md

MrButler

Android Arsenal Release API AndroidWeekly

Reactive Android App Permissions API with delegates and logging.

API Description
request(vararg permissions: String) emit true if all requested permissions granted
requestSingle(permission: String) emit result of permission request
requestEach(vararg permissions: String) emit results for each permission request
check(vararg permissions: String) emit true if all permissions already granted
checkSingle(permission: String) emit result of availability check permission
checkEach(vararg permissions: String) emit result of availability check each permission
require(vararg permissions: String) throw PermissionsDeniedException if permission denied

Download

Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Add the dependency

dependencies {
    compile 'com.github.jetradarmobile:mrbutler:1.0.3'
}

Usage

Request LOCATION permission

mrButler(activity)
    .request(Manifest.permission.ACCESS_FINE_LOCATION)
    .subscribe { granted -> ... }

A feature of this implementation is Delegates. Using delegates you can request permission anywhere.

Initialize MrButler

class App : Application() {
  val permissionsActivityDelegate = PermissionsActivityDelegate()
  val mrButler = MrButler(permissionsActivityDelegate) { message ->
    Log.i("Permissions", message)
  }

  override fun onCreate() {
    super.onCreate()
    instance = this
  }

  companion object {
    lateinit var instance: App
  }
}

Associate the permissions delegate with activity

class MainActivity : AppCompatActivity() {
  private val permissionsDelegate = App.instance.permissionsActivityDelegate

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    permissionsDelegate.attach(this)
    // ...
  }

  override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<out String>, grantResults: IntArray) {
    super.onRequestPermissionsResult(requestCode, permissions, grantResults)
    permissionsDelegate.onRequestPermissionsResult(requestCode, permissions, grantResults)
  }

  override fun onDestroy() {
    super.onDestroy()
    permissionsDelegate.detach()
  }
}

Request permissions anywhere

App.instance.mrButler
    .request(Manifest.permission.ACCESS_FINE_LOCATION)
    .subscribe { granted -> ... }

License

Copyright 2018 JetRadar

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.