Git Product home page Git Product logo

santosh-kumar-kaushal / easyworkmanager Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 1.0 146 KB

BackGround guaranteed task completion with easy workmanager library.

Kotlin 100.00%
workmanager-kotlin workmanager-architecturecomponent workmanager workmanager-example background-jobs background-worker background-thread guaranteed-delivery jetpack-workmanager android easytouse easytounderstand mvvm mvvm-android

easyworkmanager's Introduction

EasyWorkManager

  • Easy to use workmanager library.

Overview of workmanager library

  • Schedule one time task.
  • Schedule periodic time task.
  • Schedule custom task with constraints.

Using workmanager Library in your Android application

Add this in your build.gradle - Project level

    repositories {
        google()
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

Add this in your build.gradle - App level

implementation 'com.github.santosh-kumar-kaushal:EasyWorkManager:1.0'

Then initialize it in onCreate() Method of Activity/Fragment/any class

override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        
       //Build Task scheduler with different options.
        TaskScheduler.Builder(this,this).
        setListener(this).setWorkType(WorkType.PERIODIC)
            .setPeriodicTime(min.toLong()).build()
        }

Implement ITaskExecutionCallback to start a background task and receive callback on task status.

   override fun onTaskExecutionInProgress() {
       Log.e("MainActivity","onTaskExecutionInProgress...")
   }

   override fun onTaskExecutionCompleted() {
       Log.e("MainActivity","onTaskExecutionCompleted.")
   }

   override fun onTaskExecutionFailed() {
       Log.e("MainActivity","onTaskExecutionFailed.")
   }

   override fun startBackgroundTask() {
       Log.e("MainActivity","startBackgroundTask.")
   }

This is how simple your activity will look like.

class MainActivity : AppCompatActivity(),ITaskExecutionCallback {
   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       val min=20*60000
       setContentView(R.layout.activity_main)

       //Build Task scheduler with different options.
       TaskScheduler.Builder(this,this).
       setListener(this).setWorkType(WorkType.PERIODIC)
           .setPeriodicTime(min.toLong()).build()
   }

   override fun onTaskExecutionInProgress() {
       Log.e("MainActivity","onTaskExecutionInProgress...")
   }

   override fun onTaskExecutionCompleted() {
       Log.e("MainActivity","onTaskExecutionCompleted.")
   }

   override fun onTaskExecutionFailed() {
       Log.e("MainActivity","onTaskExecutionFailed.")
   }

   @RequiresApi(Build.VERSION_CODES.N)
   override fun startBackgroundTask() {
       Log.e("MainActivity","startBackgroundTask.")
       fetchDataFromApi()
   }

Want to create your own task scheduler just extend TaskScheduler.

class OwnTaskScheduler(
    context: Context,
    lifecycleOwner: LifecycleOwner,
    iTaskExecutionCallback: ITaskExecutionCallback,
    workType: WorkType
) : TaskScheduler(context, lifecycleOwner, iTaskExecutionCallback, workType) {

    private lateinit var oneTimeWorkRequest: OneTimeWorkRequest

    //Your own constraints.
    override var constraints: Constraints =
        Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build()

    //Your own request type.
    override fun scheduleCustomRequest() {
        oneTimeWorkRequest =
            OneTimeWorkRequest.Builder(BackGroundWorker::class.java)
                .setConstraints(constraints)
                .build()
        workManager.enqueue(oneTimeWorkRequest)
        //Set the callbacks to listen to changes.
        listenToCallbacks(oneTimeWorkRequest.id)
    }
}

License

   Copyright (C) 2020 Santosh Kumar

   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.
   

easyworkmanager's People

Contributors

santosh-kumar-kaushal avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

hardik24895

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.