Code Monkey home page Code Monkey logo

overlayhelper's Introduction

OverlayHelper

Release

This utility library aims to help Android developers handle "draw overlays" (also called "draw over other apps") permissions and queries in a version-agnostic way.

Installation

Add the following dependencies to your main build.gradle:

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

Add the following dependencies to your app's build.gradle:

  • For Gradle < 4.0

    dependencies {
        compile "com.github.adriangl:overlayhelper:1.1.0"
    }
  • For Gradle 4.0+

    dependencies {
        implementation "com.github.adriangl:overlayhelper:1.1.0"
    }

Example usage

  • Create a new OverlayHelper with a OverlayPermissionChangedListener.
  • Start watching settings changes with OverlayHelper.startWatching(), for example in onCreate().
  • Stop watching changes with OverlayHelper.stopWatching() in onDestroy().
  • If you want to check if the app has their "draw overlays" permission enabled, use OverlayHelper.canDrawOverlays().
  • Call OverlayHelper.requestDrawOverlaysPermission() wherever you want in your activity. You'll have to also add OverlayHelper.onRequestDrawOverlaysPermissionResult(int) in the activity's onActivityResult(), so the helper can retrieve the needed data.
  • You'll receive your permission results in the OverlayPermissionChangedListener that you registered when creating the helper.

Check the example app for more implementation details.

License

Copyright (C) 2018 Adrián García

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.

overlayhelper's People

Contributors

adriangl avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.