Skip to content

Latest commit

 

History

History
104 lines (81 loc) · 2.76 KB

README.md

File metadata and controls

104 lines (81 loc) · 2.76 KB
Raw

RxWorkManagerObservers

This library contains a set of extension functions to the WorkManager and LiveData allowing to observe enqueued work in a reactive manner.

Download

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
dependencies {
      implementation 'com.github.PaulinaSadowska:RxWorkManagerObservers:1.0.0'
}

The library does not depend on work-rxjava2. It works with any type of worker that can be enqueued by the WorkManager.

WorkManager extensions

Observing the Data by id:

WorkManager.getInstance().getWorkDataByIdSingle(request.id)
			 .subscribe(...)

Observing the WorkInfo by id:

WorkManager.getInstance().getWorkInfoByIdObservable(request.id)
			 .subscribe(...)

Observing the Data by tag

WorkManager.getInstance().getWorkDatasByTagObservable(tag = WORK_TAG, ignoreError = false)
			 .subscribe(...)

Unique work

WorkManager.getInstance().getWorkDatasForUniqueWorkObservable(WORK_NAME)
			 .subscribe(...)

LiveData to Observable conversion methods

Observing the Data by id:

WorkManager.getInstance().getWorkInfoByIdLiveData(request.id)
        		 .toWorkDataSingle()
			 .subscribe(...)

Observing the WorkInfo by id:

WorkManager.getInstance().getWorkInfoByIdLiveData(request.id)
        		 .toWorkInfoObservable()
			 .subscribe(...)

Observing the Data by tag

WorkManager.getInstance().getWorkInfosByTagLiveData(WORK_TAG)
        		 .toWorkDatasObservable()
			 .subscribe(...)

Unique work

WorkManager.getInstance().getWorkInfosForUniqueWorkLiveData(WORK_NAME)
        		 .toWorkDatasObservable()
			 .subscribe(...)

Threading

The Observable returned from each function from this library have to be subscribed on the main thread (because there is LiveData.observeForever called under the hood). The actual work, will still be executed on the background thread specified by the WorkManager.

More info

More about this library and the WorkManager you can read in my article:

How to use WorkManager with RxJava

License

Copyright 2019 Paulina Sadowska

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.