Facilitates interaction with Twitter v2 API, enabling tweet retrieval, real-time tweet streaming with filters, and simple OAuth2 authentication. Designed for Android applications with coroutine support for asynchronous operations.
Library is currently in alpha and the API might change as the Twitter v2 API changes
Tweedle is an Android library built around the Twitter v2 API built fully in Kotlin using Kotlin Coroutines
Usage
class MainViewModel: ViewModel() {
val oauth2 = OAuth2(token)
private val _tweetLookup:TweetsLookup = TweetsLookup(oauth2)
fun getTweet(tweetId:Long):LiveData<Response<SingleTweetPayload?>>{
val liveData:MutableLiveData<Response<SingleTweetPayload?>> = MutableLiveData<Response<SingleTweetPayload?>>()
viewModelScope.launch{
val response = _tweetLookup.getTweet(tweetId)
liveData.postValue(response)
}
liveData
}
}
_viewModel.getTweet(1299418846990921728).observe(this, Observer {
when(it){
is Response.Error -> {it.exception}
is Response.Success -> it.data
}
})
Tweedle also supports streaming in real time of current tweets based on filters/rules applied
Creating a filter
You can easily create a filter with the filter builder
Say we want to stream tweets that come in for the hashtag #SundayMorning and only in english. That filter would look like this
val filters:MutableList<Add> = mutableListOf()
val filter: Filter = Filter.Builder()
.addOperator("#SundayMorning")
.and()
.setLanguage(Filter.ENGLISH)
.build()
See additional examples here as well as the twiter documentation about creating filters here
(Streaming only supports OAuth2)
val oAuth2 = OAuth2(token)
val _tweetStream = TweetsStream(oAuth2)
val addRule = Add(filter.filter, "Sunday Morning")
filters.add(addRule)
val rule = Rule(filters)
_tweetStream.addRules(token, rule)
Currently Twitter only supports 25 filters/rules per API key
To start streaming tweets call the startTweetStream endpoint
_tweetStream.startTweetStream().collect {
when(it){
is Response.Success -> Log.d("TWEET", it.data.data.text)
}
}
Collect is called every time a new tweet is received
To read about how to authenticate with the api see authentication
To start using Tweedle, include the dependency in your build.gradle
Common
implementation("io.github.tyczj:tweedle:{tweedle_version}")
Android
android{
buildTypes {
debug { matchingFallbacks = ['release'] }
}
}
implementation 'io.github.tyczj:tweedle-android:{tweedle_version}'
Surfaced from shared tags and platforms — no rankings paid for.