Skip to content
Kotlin API for StackExchange chat
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
src/main/kotlin/com/timcastelijns/chatexchange
.gitignore
LICENSE
README.md
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

ChatExchange

Kotlin API for StackExchange chat

This is a kotlin port of ChatExchange.

Structurally it is almost completely the same as the original, hence all credit for that goes to original creator(s) and maintainer(s) of that project, most notably Tunaki.

Gradle dependency

Add the Jitpack repository:

repositories {
        maven { url 'https://jitpack.io' }
}

Add the dependency:

dependencies {
    implementation 'com.github.TimCastelijns:ChatExchange:version'
}

Where version should be equal to that of the jitpack badge above.

Older versions can be found here.

How to use

TBD

Status

All functionality has been ported, but not everything has been fully tested.

A test file exists for this purpose (see below). Currently there are no automated tests.

Things left to do

  • Prettify the code

    It is currently basically the kotlin version of the java code. It would be great to convert whatever possible to idiomatic kotlin.

  • Handle unhandled events

    Currently only a specific subset of events are handled. It would be great to support all of them, and separate them by purpose. E.g. MessageStarred and MessagePinned could be 2 separate events.

Testing

There is a very basic set up in Test.kt that joins the sandbox room and attached event listeners.

This can be used for testing purposes, but requires a file credentials.properties to be present in the root with format:

email=<email>
password=<password>

Enter the credentials for the account you are using to connect to chat.

You can’t perform that action at this time.