Documentation moved http://kotlogram.badoualy.com ===========
Easy to use and straightforward Kotlin (and Java) binding of Telegram API. The project is coded in Kotlin, with some classes (mostly generated and legacy classes) in Java The Java code will be replaced by Kotlin over time
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 interoperable with Java! You can use this as a standard Java Library
The project is still in beta, a lot is yet to be done. It comes with absolutely no warranty! Main tasks left:
- Implement Perfect Forward Secrecy.
First, add JitPack to your project if that's not already the case, in your build.gradle:
repositories {
// ...
maven { url "https://jitpack.io" }
}Then add the library dependency:
compile 'com.github.badoualy:kotlogram:0.0.6'Telegram has yet to update the documentation (currently stopped at layer 18, using layer 45), but I will not document all the features myself. So please, restrain from opening ticket to ask "How can I send a sticker", "How can I create a group". You can either try to look at the old documentation or the source of official applications and figure it out yourself, I won't be doing Telegram's job nor yours. Kotlogram is just here to provide a binding of the API, not a documentation.
However, I will supply a simple example on how to use the library itself to call rpc methods.
You need to implement your own C class holding all the constants, it's not included in the repository since it contains confidential information such as my phone number, api id, ...
// Activate debug log or not, false by default
// Kotlogram.setDebugLogEnabled(true);
// Replace the following constants with your app's information
// This informations are used in initConnection and sendCode rpc methods
TelegramApp app = new TelegramApp(C.API_ID, C.API_HASH, C.MODEL, C.SYSTEM_VERSION, C.APP_VERSION, C.LANG_CODE);
// This is a synchronous client, that will block until the response arrive (or until timeout)
// A client which return an Observable<T> where T is the response type will be available soon
// TelegramClient interface contains 1 method for each RPC method described in the TL-Schema,
// and some more convenience methods (like to download a UserPhoto)
TelegramClient client = Kotlogram.getDefaultClient(app, new ApiStorage());
// You can start making requests
try {
// Send code to account
TLAbsSentCode sentCode = client.authSendCode(C.PHONE_NUMBER, 5);
System.out.println("Authentication code: ");
String code = new Scanner(System.in).nextLine();
// Auth with the received code
TLAuthorization authorization = client.authSignIn(C.PHONE_NUMBER, sentCode.getPhoneCodeHash(), code);
TLUser self = authorization.getUser().getAsUser();
System.out.println("You are now signed in as " + self.getFirstName() + " " + self.getLastName());
// Start making cool stuff!
// Get a list of 10 most recent conversations
TLAbsDialogs dialogs = client.messagesGetDialogs(0, 0, new TLInputPeerEmpty(), 10);
for (TLAbsMessage message : dialogs.getMessages()) {
if (message instanceof TLMessage) {
System.out.println("Found message " + ((TLMessage) message).getMessage());
} else {
System.out.println("Found a service message or empty message");
}
}
// Take the first user in the list, and send a message to him
// It'll probably be Telegram bot, since he'll send you the code
TLUser randomUser = dialogs.getUsers().get(0).getAsUser();
TLInputPeerUser inputUser = new TLInputPeerUser(randomUser.getId(), randomUser.getAccessHash());
int randomId = new Random(System.currentTimeMillis()).nextInt();
client.messagesSendMessage(false, false, inputUser, 0, "Kotlogram is awesome!", randomId, null, null);
System.out.println("Message sent");
} catch (RpcErrorException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
client.close(); // Important, do not forget this, or your process won't finish
}
System.out.println("------------------------- GOOD BYE");The project is composed by the following modules:
- tl-builder: Type Language compiler
- tl: Type Language library
- mtproto: MTProto Mobile Protocol library
- api
tl-builder: Type Language compiler
Converts json-representation of TL Schema to Java classes with generated classes for serializing and deserializing api messages and methods to their binary representation (see Binary Data Serialization). Used JavaPoet to generate the classes.
- Run the main class in tl-builder module with the layer value
The classes will be generated in the tl module in the package com.github.badoualy.telegram.tl.api.
tl: Type Language library
Contains the base type of the Type Language (int, long, Vecor, ...) and the classes generated by the tl-builder. This module is the lowest level in the library, it supplies all the necessary classes to serialize/deserialize objects describe in the TL Schema.
"TL Language (Type Language or Time Limit) serves to describe the used system of types, constructors, and existing functions. In fact, the combinator description format presented in Binary Data Serialization is used."
mtproto: MTProto Mobile Protocol library
Contains all the necessary stuff to make RPC (Remote Procedure Call) and handle all the low-level stuff (like handling salt, etc.)
MTProto is the Telegram Messenger protocol "designed for access to a server API from applications running on mobile devices".
The Mobile Protocol is subdivided into three components (from the official site):
-
High-level component (API query language): defines the method whereby API queries and responses are converted to binary messages.
-
Cryptographic (authorization) layer: defines the method by which messages are encrypted prior to being transmitted through the transport protocol.
-
Transport component: defines the method for the client and the server to transmit messages over some other existing network protocol (such as, http, https, tcp, udp).
High-level API to easily use Telegram's api methods without having to understand the first thing about MTProto or TL Language :) An old fashioned Java API (like using RestFB or a any Rest API binding)
The MIT License (MIT)
Copyright (c) 2015 Yannick Badoual
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.