{"_id":"5703d527bb69fc1700553ce6","project":"5703d527bb69fc1700553ce0","version":"5703d527bb69fc1700553ce3","hidden":false,"link_external":false,"link_url":"","order":0,"user":"5631f962c3b04b0d00ba9bf1","__v":11,"createdAt":"2016-04-05T15:09:27.684Z","parentDoc":null,"type":"basic","excerpt":"Easy to use and straightforward Kotlin (and Java) binding of Telegram API","githubsync":"","isReference":false,"sync_unique":"","title":"Welcome","updates":[],"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[![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)\n## Current layer: 53\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"**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.\\n\\n**Kotlin, what is that, I don't know this language!**\\nDon'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\",\n  \"title\": \"What is Kotlogram?\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Check latest version on JitPack\",\n  \"body\": \"I may not have released a new version in a while, it doesn't mean that the library development has stopped.\\n- Use the latest commit hash as a version number (you can check on [jitpack](https://jitpack.io/#badoualy/kotlogram) at any time\\n- Open a ticket and ask the latest stable commit hash\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"This is not a Telegram API documentation\",\n  \"body\": \"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).\\nBut 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.\\nPlease, restrain from opening ticket about questions on the API, as I'll ignore them if I don't have the answer.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Beta\",\n  \"body\": \"The project is still in beta, a lot is yet to be done. It comes with absolutely no warranty! Main tasks left:\\n  - Implement [Perfect Forward Secrecy](https://core.telegram.org/api/pfs).\"\n}\n[/block]\n# Getting started:\nFirst, add [JitPack](https://jitpack.io/) to your project if that's not already the case, in your `build.gradle`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"repositories {\\n    // ...\\n    maven { url \\\"https://jitpack.io\\\" }\\n}\",\n      \"language\": \"groovy\"\n    }\n  ]\n}\n[/block]\nThen add the library dependency:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"compile 'com.github.badoualy:kotlogram:47f69d4ce8'\",\n      \"language\": \"groovy\"\n    }\n  ]\n}\n[/block]","category":"5703d527bb69fc1700553ce4","slug":"getting-started","childrenPages":[]}

Welcome

Easy to use and straightforward Kotlin (and Java) binding of Telegram API

[![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) ## Current layer: 53 [block:callout] { "type": "info", "body": "**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.\n\n**Kotlin, what is that, I don't know this language!**\nDon'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", "title": "What is Kotlogram?" } [/block] [block:callout] { "type": "warning", "title": "Check latest version on JitPack", "body": "I may not have released a new version in a while, it doesn't mean that the library development has stopped.\n- Use the latest commit hash as a version number (you can check on [jitpack](https://jitpack.io/#badoualy/kotlogram) at any time\n- Open a ticket and ask the latest stable commit hash" } [/block] [block:callout] { "type": "warning", "title": "This is not a Telegram API documentation", "body": "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).\nBut 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.\nPlease, restrain from opening ticket about questions on the API, as I'll ignore them if I don't have the answer." } [/block] [block:callout] { "type": "danger", "title": "Beta", "body": "The project is still in beta, a lot is yet to be done. It comes with absolutely no warranty! Main tasks left:\n - Implement [Perfect Forward Secrecy](https://core.telegram.org/api/pfs)." } [/block] # Getting started: First, add [JitPack](https://jitpack.io/) to your project if that's not already the case, in your `build.gradle`: [block:code] { "codes": [ { "code": "repositories {\n // ...\n maven { url \"https://jitpack.io\" }\n}", "language": "groovy" } ] } [/block] Then add the library dependency: [block:code] { "codes": [ { "code": "compile 'com.github.badoualy:kotlogram:47f69d4ce8'", "language": "groovy" } ] } [/block]