Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/badoualy/kotlogram

Telegram API for Java/Kotlin easy to use and straightforward
https://github.com/badoualy/kotlogram

Last synced: about 1 month ago
JSON representation

Telegram API for Java/Kotlin easy to use and straightforward

Host: GitHub
URL: https://github.com/badoualy/kotlogram
Owner: badoualy
License: mit
Archived: true
Created: 2016-01-03T12:27:35.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2018-07-24T16:37:35.000Z (over 6 years ago)
Last Synced: 2024-08-03T16:08:33.847Z (5 months ago)
Language: Java
Homepage: http://kotlogram.badoualy.com
Size: 8.58 MB
Stars: 228
Watchers: 24
Forks: 87
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-telegram - kotlogram - Easy to use and straightforward Kotlin (and Java) binding of Telegram API (Bots / Bot Libs)

README

![Kotlogram](http://s28.postimg.org/u3sc3e24t/logo.png)

[![Release](https://jitpack.io/v/badoualy/kotlogram.svg)](https://jitpack.io/#badoualy/kotlogram) [![Build Status](https://travis-ci.org/badoualy/kotlogram.svg?branch=master)](https://travis-ci.org/badoualy/kotlogram)

**Easy to use** and **straightforward** Kotlin and Java binding of [Telegram API](https://core.telegram.org/api).
The project is coded in **Kotlin**, with some classes (mostly legacy classes) in Java

Current layer: 66
===========
Documentation@[http://kotlogram.badoualy.com](http://kotlogram.badoualy.com)
===========

Kotlin, what is that, I don't know this language!
----------------
Don't worry, Kotlin is a JVM language just like Java and Scala, and is fully interoperable with Java! You can use this as a standard Java Library.
Kotlogram uses Kotlin to improve the usability of the lib. The TL Language used by Telegram's protocol as used requires a lot of boilerplate code when modeled in a language like Java. To be more developer-friendly, the lib includes a lot of utils in the form of Kotlin extension functions and properties.

TODO list
----------------
- Implement [Perfect Forward Secrecy](https://core.telegram.org/api/pfs).
- Implement CDN redirection handling when downloading files.

Important notes
----------------
This documentation's only purpose is to explain how the library works, and how to use it. Telegram documentation is sadly completely outdated and not of any use. Probably at some point in the future they'll either close the public API, or release new documentation (I'm hoping for the latter).
But this documentation **will not explain how to use their API**, like how to get messages older than the date `X` or all the parameters of a rpc method.
Please, restrain from opening ticket about questions on the API, as I'll ignore them if I don't have the answer.

Usage
----------------
#### Dependency

First, add [JitPack](https://jitpack.io/) to your project if that's not already the case, in your `build.gradle`:

```gradle
repositories {
// ...
maven { url "https://jitpack.io" }
}
```

Then add the library dependency:
```gradle
compile 'com.github.badoualy:kotlogram:1.0.0-RC3'
```

Licence
----------------
```
The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```