NewsApiClient-Kotlin
Create an account at newsapi.org to get your API key.
Step 1. Add the JitPack repository to your root build.gradle file.
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}Step 2 : Download via Gradle:
implementation 'com.github.ayodkay:NewsApiClient-Kotlin:1.0.5'Usage with observer
Instantiate the Client class:
NewsApi.init(this)val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY")val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY", NetworkInterceptorModel(), OfflineCacheInterceptorModel())val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY", NetworkInterceptorModel())val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY", OfflineCacheInterceptorModel())NetworkInterceptorModel() and OfflineCacheInterceptorModel() helps cache result for a specific amount of hours, minutes or even days. By default it is 1 hour and to change
val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY", NetworkInterceptorModel(1,TimeUnit.MINUTES))val newsApiClientWithObserver = NewsApiClientWithObserver("YOUR_API_KEY", OfflineCacheInterceptorModel(1,TimeUnit.DAYS))Get Top EveryThing doc
val everythingBuilder = EverythingBuilder.Builder()
.q("bitcoin")
.build()
newsApiClientWithObserver
.getEverything(everythingBuilder, object : ArticlesLiveDataResponseCallback {
override fun onSuccess(response: MutableLiveData<ArticleResponse>) {
response.observe(this@MainActivity2 ){
Log.d(TAG, "onSuccess articles: ${it.articles}")
Log.d(TAG, "onSuccess status: ${it.status}")
Log.d(TAG, "onSuccess totalResults: ${it.totalResults}")
Log.d(TAG, "-------------------------------------------------")
}
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
})Get Top Headlines doc
val topHeadlinesBuilder = TopHeadlinesBuilder.Builder()
.q("bitcoin")
.country(NewsConstant.COUNTRY_BR)
.category(NewsConstant.CATEGORY_BUSINESS)
.build()
newsApiClientWithObserver
.getTopHeadlines(topHeadlinesBuilder, object : ArticlesLiveDataResponseCallback {
override fun onSuccess(response: MutableLiveData<ArticleResponse>) {
response.observe(this@MainActivity2 ){
Log.d(TAG, "onSuccess articles topHeadlinesBuilder: ${it.articles}")
Log.d(TAG, "onSuccess status topHeadlinesBuilder: ${it.status}")
Log.d(TAG, "onSuccess totalResults topHeadlinesBuilder: ${it.totalResults}")
Log.d(TAG, "-------------------------------------------------")
}
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
})Get Sources doc
val sourcesBuilder = SourcesBuilder.Builder()
.language("en")
.country("us")
.build()
newsApiClientWithObserver
.getSources(sourcesBuilder, object : SourcesLiveDataCallback {
override fun onSuccess(response: MutableLiveData<SourcesResponse>) {
response.observe(this@MainActivity2 ){
Log.d(TAG, "onSuccess status getSources: ${it.status}")
Log.d(TAG, "onSuccess status getSources: ${it.sources}")
Log.d(TAG, "-------------------------------------------------")
}
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
})___________________________________________________________________________________________
Usage without observer
Instantiate the Client class:
NewsApi.init(this)val newsApiClient = NewsApiClient("YOUR_API_KEY")val newsApiClient = NewsApiClient("YOUR_API_KEY", NetworkInterceptorModel(), OfflineCacheInterceptorModel())val newsApiClient = NewsApiClient("YOUR_API_KEY", NetworkInterceptorModel())val newsApiClient = NewsApiClient("YOUR_API_KEY", OfflineCacheInterceptorModel())NetworkInterceptorModel() and OfflineCacheInterceptorModel() helps cache result for a specific amount of hours, minutes or even days. By default it is 1 hour and to change
val newsApiClient = NewsApiClient("YOUR_API_KEY", NetworkInterceptorModel(1,TimeUnit.MINUTES))val newsApiClient = NewsApiClient("YOUR_API_KEY", OfflineCacheInterceptorModel(1,TimeUnit.DAYS))Get Top EveryThing doc
val everythingBuilder = EverythingBuilder.Builder()
.q("bitcoin")
.build()
newsApiClient.getEverything(
everythingBuilder,
object : ArticlesResponseCallback {
override fun onSuccess(response: ArticleResponse) {
Log.d(TAG, "onSuccess articles: ${response.articles}")
Log.d(TAG, "onSuccess status: ${response.status}")
Log.d(TAG, "onSuccess totalResults: ${response.totalResults}")
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
}
)Get Top Headlines doc
val topHeadlinesBuilder = TopHeadlinesBuilder.Builder()
.q("bitcoin")
.build()
newsApiClient.getTopHeadlines(
topHeadlinesBuilder,
object : ArticlesResponseCallback {
override fun onSuccess(response: ArticleResponse) {
Log.d(TAG, "onSuccess articles: ${response.articles}")
Log.d(TAG, "onSuccess status: ${response.status}")
Log.d(TAG, "onSuccess totalResults: ${response.totalResults}")
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
}
)Get Sources doc
val sourcesBuilder = SourcesBuilder.Builder()
.language("en")
.country("us")
.build()
newsApiClient.getSources(
sourcesBuilder,
object : SourcesCallback {
override fun onSuccess(response: SourcesResponse) {
Log.d(TAG, "onSuccess articles: ${response.sources}")
Log.d(TAG, "onSuccess status: ${response.status}")
}
override fun onFailure(throwable: Throwable) {
Log.d(TAG, "onFailure: $throwable")
}
}
)