Skip to content

Latest commit

 

History

History
180 lines (128 loc) · 5.16 KB

README.md

File metadata and controls

180 lines (128 loc) · 5.16 KB

TelegramManager

v1.0.2

This is a Java Based library useful to work with Telegram's API service.

Implementation

Add the JitPack repository to your build file

Gradle

  • Add it in your root build.gradle at the end of repositories

    Gradle (Short)

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

    Gradle (Kotlin)

    repositories {
        ...
        maven("https://jitpack.io")
    }
  • Add the dependency

    Gradle (Short)

    dependencies {
        implementation 'com.github.N7ghtm4r3:TelegramManager:1.0.2'
    }

    Gradle (Kotlin)

    dependencies {
        implementation("com.github.N7ghtm4r3:TelegramManager:1.0.2")
    }

Maven

  • Add it in your root build.gradle at the end of repositories
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
  • Add the dependency
<dependency>
    <groupId>com.github.N7ghtm4r3</groupId>
    <artifactId>TelegramManager</artifactId>
    <version>1.0.2</version>
</dependency>

🛠 Skills

  • Java

Managers available

  • Bot API

The other managers will be gradually released

Usage/Examples

Creating a Bot

To use correctly the library you must before create the bot and its token to pass to the managers to correctly perform their workflow, you can follow how do to it here

Execution

try{
    ContentManager contentManager = new ContentManager();
    contentManager.sendMessage("Hello from TelegramManager");
}catch(Exception e){
    e.printStackTrace();
}

To avoid re-entering credentials for each manager, you can instantiate managers like this with the ARCS:

// choose the manager, for example: StickersManager, PassportManager, etc
TelegramManager firstManager = new TelegramManager(/* params of the constructor chosen */, "accessToken");
// and then use it 
firstManager.makeSomething();
// you don't need to insert all credentials to make manager work
TelegramManager secondManager = new TelegramManager(); // same credentials used
// and then use it
secondManager.makeSomething();

Responses

Library give to you the opportunity to customize the return object after a request, the possibilities are:

  • JSON: return response formatted as JSON (org.json.JSONObject or org.json.JSONArray)
  • STRING: return response formatted as String
  • LIBRARY_OBJECT: return response formatted as custom object offered by the library
// choose the manager for example: StickersManager, PassportManager, etc
TelegramManager manager = new TelegramManager(/* params of the constructor chosen */);
// method to return directly a library given by library
manager.someRequest(); // in this case will be returned directly a LIBRARY_OBJECT
// method to customize the format of the return 
manager.someRequest(ReturnFormat.JSON); // in this case will be returned response in JSON format

Errors handling

try{
    System.out.println(manager.sendMessage("Hello from TelegramManager"));
}catch(Exception e){
    System.out.println(manager.getErrorResponse());
    //or
    manager.printErrorResponse();
}

/* NOTE: if is not a request error will appear: "Error is not in api request, check out your code"
  and you will have to work on your code to manage error*/

Authors

Support

If you need help using the library or encounter any problems or bugs, please contact us via the following links:

Thank you for your help!

Badges

Twitter

Donations

If you want support project and developer

Crypto Address Network
3H3jyCzcRmnxroHthuXh22GXXSmizin2yp Bitcoin
0x1b45bc41efeb3ed655b078f95086f25fc83345c4 Ethereum

If you want support project and developer with PayPal

Copyright © 2024 Tecknobit