Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominaezzz/matrix-kt
Kotlin libraries for Matrix.
https://github.com/dominaezzz/matrix-kt
kotlin kotlin-multiplatform matrix matrix-org matrix-sdk olm
Last synced: 4 months ago
JSON representation
Kotlin libraries for Matrix.
- Host: GitHub
- URL: https://github.com/dominaezzz/matrix-kt
- Owner: Dominaezzz
- License: apache-2.0
- Created: 2019-09-01T12:08:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-09T15:36:48.000Z (over 2 years ago)
- Last Synced: 2023-07-04T04:34:13.769Z (over 1 year ago)
- Topics: kotlin, kotlin-multiplatform, matrix, matrix-org, matrix-sdk, olm
- Language: Kotlin
- Size: 760 KB
- Stars: 28
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://github.com/Dominaezzz/matrix-kt/actions)
# Matrix in Kotlin
Kotlin multiplatform libraries for [Matrix](https://matrix.org/).
- [x] Http Client
- [x] olm
- [ ] SDK
Join the support room at [#matrix-kt:matrix.org](https://matrix.to/#/#matrix-kt:matrix.org).
# Supported platforms
- JVM
- Android
- JavaScript
- LinuxX64
- MingwX64
- MacosX64
- IosArm32
- IosArm64
- IosX64
## Usage
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("io.github.dominaezzz.matrixkt:client:$version")
implementation("io.github.dominaezzz.matrixkt:olm:$version")
}
```
## Sample
### Client
```kotlin
val client = HttpClient(Apache) {
MatrixConfig(baseUrl = Url("matrix.org"))
}
val accessToken = "Super secure Token"
val roomId = "!QtykxKocfZaZOUrTwp:matrix.org"
val response = client.rpc(SendMessage(
SendMessage.Url(roomId, "m.room.message", "nonce"),
buildJsonObject {
put("msgtype", "m.text")
put("body", "Hello World!")
}
), accessToken)
val eventId = response.eventId
client.rpc(RedactEvent(
RedactEvent.Url(roomId, eventId, "nonce2"),
RedactEvent.Body(reason = "Was a bot!")
), accessToken)
```
### Olm
```kotlin
val account = Account()
upload(account.identityKeys)
val signature = account.sign("""{"key":"super secure key for security things"}""")
val session = Session.createInboundSession(account, "PREKEY message")
val message = session.decrypt(Message.PreKey("oun02024f=ocnaowincd;53tnv024ok/7u"))
session.clear()
account.clear()
```
#### JS
Javascript has a special prerequisites.
Before being able to use the matrix-kt lib you need to initiate the olm library.
```js
require("@matrix-org/olm").init()
```
Please read the olm [documentation](https://gitlab.matrix.org/matrix-org/olm/-/tree/master/javascript#olm) for further instructions on initiating the
olm library.