Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tyczj/Tweedle
A Kotlin based Android library around the Twitter v2 API
https://github.com/tyczj/Tweedle
Last synced: 3 months ago
JSON representation
A Kotlin based Android library around the Twitter v2 API
- Host: GitHub
- URL: https://github.com/tyczj/Tweedle
- Owner: tyczj
- Created: 2020-09-07T00:59:40.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-09T00:06:11.000Z (over 1 year ago)
- Last Synced: 2024-05-12T06:34:02.849Z (6 months ago)
- Language: Kotlin
- Size: 267 KB
- Stars: 39
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Tweedle
[](https://developer.twitter.com/en/docs/twitter-api)
# Due to twitter going to a paid API this project is no longer going to be maintained. I am not paying $100/month for API access just to create a library that I wont be making any money on.
***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](https://developer.twitter.com/en/docs/twitter-api/early-access) built fully in Kotlin using Kotlin Coroutines
Usage
### ViewModel
```kotlin
class MainViewModel: ViewModel() {
val oauth2 = OAuth2(token)
private val _tweetLookup:TweetsLookup = TweetsLookup(oauth2)
fun getTweet(tweetId:Long):LiveData>{
val liveData:MutableLiveData> = MutableLiveData>()
viewModelScope.launch{
val response = _tweetLookup.getTweet(tweetId)
liveData.postValue(response)
}
return liveData
}
}
```
### Activity
```kotlin
_viewModel.getTweet(1299418846990921728).observe(this, Observer {
when(it){
is Response.Error -> {it.exception}
is Response.Success -> it.data
}
})
```
## Streaming
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
```kotlin
val filters:MutableList = mutableListOf()
val filter: Filter = Filter.Builder()
.addOperator("#SundayMorning")
.and()
.setLanguage(Filter.ENGLISH)
.build()
```
See additional examples [here](https://github.com/tyczj/Tweedle/blob/master/lib/src/test/java/com/tycz/tweedle/lib/FilterBuilderTest.kt) as well as the twiter documentation about creating filters [here](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/integrate/build-a-rule)
### Adding a filter/rule
(Streaming only supports OAuth2)
```kotlin
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
```kotlin
_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
### Authentication
To read about how to authenticate with the api see [authentication](https://github.com/tyczj/Tweedle/blob/master/tweedle/src/commonMain/kotlin/com.tycz.tweedle.lib/authentication)
To start using Tweedle, include the dependency in your `build.gradle`
Common
```kotlin
implementation("io.github.tyczj:tweedle:{tweedle_version}")
```
Android
```kotlin
android{
buildTypes {
debug { matchingFallbacks = ['release'] }
}
}
implementation 'io.github.tyczj:tweedle-android:{tweedle_version}'
```