One Message Bot

https://zoommax.github.io/OneMessageBot/
Admin
One Message Bot is a library that provides a convenient framework for creating Telegram bots,...
Tokens:7,538
Snippets:63
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Run the Bot (Java)

Source: https://zoommax.github.io/OneMessageBot/quickstart

This Java code snippet shows the process of running the OneMessageBot. It involves creating a BotApp instance with the previously configured BotSettings and starting it in a new thread. Ensure BotSettings are properly initialized before this step.

```java
package test.cl;

import space.zoommax.BotApp;

public class Main {
    public static void main(String[] args) {
        //BotSettings botSettings = BotSettings.builder()
        // ...
        // .build();

        new Thread(new BotApp(botSettings)).start();
    }
}
```

--------------------------------

### Handle Telegram Bot Start Command and Messages in Java

Source: https://zoommax.github.io/OneMessageBot/quickstart

This Java snippet demonstrates how to handle the '/start' command and subsequent messages in a Telegram bot. It sets the user's language and constructs a text message with a custom keyboard containing links and action buttons. It also handles callback queries for specific button presses.

```java
package test.cl;

import com.pengrad.telegrambot.model.PhotoSize;
import com.pengrad.telegrambot.model.Update;
import space.zoommax.BotApp;
import space.zoommax.utils.CreateNotification;
import space.zoommax.utils.ViewMessageImpl;
import space.zoommax.utils.db.NotificationType;
import space.zoommax.utils.keyboard.Keyboard;
import space.zoommax.view.TextMessage;
import space.zoommax.view.ViewMessage;

@ViewMessageListener
public class Start implements ViewMessageImpl {
    @Override
    public ViewMessage onMessage(String message, int messageId, long chatId, String onMessageFlag, Update update) {
        if (onMessageFlag.equals("start")) {
            return TextMessage.builder()
                    .onMessageFlag("start")
                    .text("Hello " + message)
                    .chatId(chatId)
                    .keyboard(Keyboard.builder()
                            .chatId(chatId)
                            .code("{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}\n" +
                                    "{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}\n" +
                                    "{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}\n" +
                                    "{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}")
                            .build())
                    .build();
        }
        return null;
    }

    @Override
    public ViewMessage onCommand(String command, int messageId, long chatId, Update update) {
        if (command.equals("/start")) {
            if (chatId == 000000) {
                BotApp.setUserLanguage(String.valueOf(chatId), "default_en_US");
            }
            return TextMessage.builder()
                    .onMessageFlag("start")
                    .text("Hello")
                    .chatId(chatId)
                    .keyboard(Keyboard.builder()
                            .chatId(chatId)
                            .code("{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}")
                            .build())
                    .build();
        }
        return null;
    }

    @Override
    public ViewMessage onPicture(PhotoSize[] photoSize, String caption, int messageId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onCallbackQuery(String data, int messageId, long chatId, Update update) {
        if (data.equals("strt")) {
            CreateNotification createNotification = new CreateNotification("Hello callback notify", String.valueOf(chatId), null, NotificationType.FULL, null);
            createNotification.run();
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            return TextMessage.builder()
                    .onMessageFlag("start")
                    .text("Hello callback")
                    .chatId(chatId)
                    .keyboard(Keyboard.builder()
                            .chatId(chatId)
                            .code("{Google;https://google.com}{Yandex;https://ya.ru}\n" +
                                    "{Start;strt}")
                            .build())
                    .build();
        }
        return null;
    }

    @Override
    public ViewMessage onInlineQuery(String query, String queryId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onChosenInlineResult(String resultId, long queryId, String chatId, Update update) {
        return null;
    }
}

```

--------------------------------

### Configure Bot Settings (Java)

Source: https://zoommax.github.io/OneMessageBot/quickstart

This Java code illustrates how to configure the settings for the OneMessageBot. It uses the BotSettings.builder() to set parameters like the bot token, database type, and language directory. This configuration is essential before running the bot.

```java
package test.cl;

import space.zoommax.BotSettings;
import space.zoommax.utils.db.DbType;

import java.io.IOException;

public class Main {
    public static void main(String[] args) throws IOException {
        BotSettings botSettings = BotSettings.builder()
                .botToken("XXXX:yyyyyy")
                .dbType(DbType.SQLITE)
                .buttonsRows(5)
                .dbName("TestBotApp")
                .languageDirPath("translations")
                .defaultLanguage("my_default_lang")
                .dbConnection(null)
                .dbUrl("jdbc:sqlite:./")
                .dbUser("")
                .dbPassword("")
                .build();
    }
}
```

--------------------------------

### Build and Send VideoMessage in Java

Source: https://zoommax.github.io/OneMessageBot/viewmessage/videomessage

This Java example demonstrates how to use the VideoMessage builder to construct a message for sending videos. It covers setting the video source via URL, chat ID, and an optional keyboard. The VideoMessage can then be sent using the run() method. Dependencies include the space.zoommax.view.VideoMessage class and potentially Keyboard.

```java
import space.zoommax.view.VideoMessage;
import java.io.File;

public class example {

    public static void main(String[] args) {
        VideoMessage videoMessage = VideoMessage.builder()
                .chatId(123456789)
                .videoAsUrl("https://example.com/video.mp4")
                /*optional
                .videoAsFile(new File("path/to/video.mp4"))
                .videoAsBytes(new byte[]{1,2,3,4,5})
                 */
                .keyboard(Keyboard.builder()
                        .chatId(123456789)
                        .code("{Google;https://google.ru}{Yandex;https://ya.ru}\n" +
                                "{Start;strt}")
                        .build())
                .caption("Hello")
                .onMessageFlag("start")
                .notify(false)
                .build();

        videoMessage.run();
    }
}
```

--------------------------------

### Retrieve Translations Using LocalizationManager

Source: https://zoommax.github.io/OneMessageBot/localization/localization

Fetch translated strings for a given chat ID and localization key. This example demonstrates how to use the LocalizationManager to get bot messages, supporting dynamic language selection based on the user's saved language preference. Accesses nested keys using dot notation.

```java
import space.zoommax.BotApp;
import space.zoommax.utils.lang.LocalizationManager;
import space.zoommax.utils.lang.UserLanguage; // Assuming UserLanguage is in this package

LocalizationManager localizationManager = BotApp.localizationManager;
String botStart = localizationManager.getTranslationForLanguage(UserLanguage.getUserLanguage(chatId), "main.bot_starting");
// botStart will contain the translated string for "main.bot_starting" for the user's language.
```

--------------------------------

### Create and Send TextMessage with Keyboard (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/textmessage

Demonstrates how to use the TextMessage builder to construct a text message. It includes setting the message text, chat ID, a custom keyboard with buttons, an on-message flag, and notification preference. The message is then sent using the run() method.

```java
import space.zoommax.view.TextMessage;

public class example {

    public static void main(String[] args) {
        TextMessage textMessage = TextMessage.builder()
                .text("Hello")
                .chatId(123456789)
                .keyboard(Keyboard.builder()
                        .chatId(123456789)
                        .code("{Google;https://google.ru}{Yandex;https://ya.ru}
{Start;strt}")
                        .build())
                .onMessageFlag("start")
                .notify(false)
                .build();
        textMessage.run();
    }
}
```

--------------------------------

### Create and Send Inline Keyboard (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/inlinekeyboard

Demonstrates how to use the InlineKeyboard builder to create an inline keyboard with specified buttons and send it to a chat. Requires the space.zoommax.view.InlineKeyboard class. It takes a chatId and a code string defining the buttons and their actions.

```java
import space.zoommax.view.InlineKeyboard;

public class example {

    public static void main(String[] args) {
        InlineKeyboard inlineKeyboard = InlineKeyboard.builder()
                .chatId(123456789)
                .code("{Google;https://google.ru}{Yandex;https://ya.ru}\n" +
                        "{Start;strt}")
                .build();

        inlineKeyboard.run();
    }
}
```

--------------------------------

### Create Buttons using Button Object (Java)

Source: https://zoommax.github.io/OneMessageBot/keyboard/button

This method creates Telegram buttons by instantiating the Button class with 'text' and 'action' fields. The 'action' field determines the button's behavior: 'mapp' for Mini Apps, 'http' or 'tg' for links, and any other string for callback actions.

```java
Button button1 = new Button("I will open a Telegram Mini App", "mapphttp://example.com");
Button button2 = new Button("I will open a link", "http://example.com");
Button button3 = new Button("I will also open a link", "tg://username");
Button button4 = new Button("I will perform a callback action", "any_data");
```

--------------------------------

### Create Telegram Keyboard with List of Buttons

Source: https://zoommax.github.io/OneMessageBot/keyboard/keyboard

Shows how to construct a Telegram keyboard programmatically using a list of `Button` objects organized into rows. This method uses the `keyboardButtons` parameter of the `Keyboard.builder`. Each inner list represents a row of buttons, and `Button` objects are defined with text and an optional URL or callback data.

```java
import space.zoommax.utils.keyboard.Button;
import space.zoommax.utils.keyboard.Keyboard;

import java.util.List;
import java.util.ArrayList;

List<Button> buttons = new ArrayList<>();
buttons.add(new Button("I will open a link", "http://example.com"));
buttons.add(new Button("I will perform a callback action", "any_data"));

List<Button> buttons2 = new ArrayList<>();
buttons2.add(new Button("I will also open a link", "tg://username"));

List<List<Button>> keyboardButtons = new ArrayList<>();
keyboardButtons.add(buttons);
keyboardButtons.add(buttons2);

Keyboard keyboard = Keyboard.builder()
        .chatId(123456789)
        .keyboardButtons(keyboardButtons)
        .build();
```

--------------------------------

### Send Audio Message using AudioMessage Builder (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/audiomessage

Demonstrates how to construct and send an audio message using the AudioMessage builder. It supports sending audio via URL, file, or byte array, and allows for optional captions, custom keyboards, and notification settings. The message can be displayed as a ViewMessage or executed directly.

```java
import space.zoommax.view.AudioMessage;
import java.io.File;

public class example {

    public static void main(String[] args) {
        AudioMessage audioMessage = AudioMessage.builder()
                .chatId(123456789)
                .audioAsUrl("https://example.com/audio.mp3")
                /*optional
                .audioAsFile(new File("path/to/audio.mp3"))
                .audioAsBytes(new byte[]{1,2,3,4,5})
                 */
                .keyboard(Keyboard.builder()
                        .chatId(123456789)
                        .code("{Google;https://google.ru}{Yandex;https://ya.ru}\n" +
                                "{Start;strt}")
                        .build())
                .caption("Hello")
                .onMessageFlag("start")
                .notify(false)
                .build();

        audioMessage.run();
    }
}

```

--------------------------------

### Create Buttons using Formatted String (Java)

Source: https://zoommax.github.io/OneMessageBot/keyboard/button

This method creates Telegram buttons by using a formatted string. The string format is '{text_on_button;button_action}'. The action can trigger a callback, open a link (http or tg), or launch a Telegram Mini App (mapp). Reserved characters like '{', '}', and ';' can be escaped with a backslash.

```java
import space.zoommax.utils.keyboard.Button;

Button button1 = new Button("{I will open a Telegram Mini App;mapphttp://example.com}");
Button button2 = new Button("{I will open a link;http://example.com}");
Button button3 = new Button("{I will also open a link;tg://username}");
Button button4 = new Button("{I will perform a callback action;any_data}");
```

--------------------------------

### Configure Custom JDBC Database in OneMessageBot (Java)

Source: https://zoommax.github.io/OneMessageBot/database/overview

Shows how to configure a custom JDBC database connection in OneMessageBot when DbType.CUSTOM is selected. Requires specifying URL, user, password, database name, and JDBC connection.

```java
botSettings.setDbUrl(url)
botSettings.setDbUser(user)
botSettings.setDbPassword(password)
botSettings.setDbName(name)
botSettings.setDbConnection(connection)
```

--------------------------------

### Maven Dependency for OneMessageBot

Source: https://zoommax.github.io/OneMessageBot/index

This code snippet shows how to add the OneMessageBot library as a dependency to your Maven project. Ensure you have Maven configured to resolve dependencies from central repositories.

```xml
<dependency>
    <groupId>space.zoommax</groupId>
    <artifactId>OneMessageBot</artifactId>
    <version>2.1.4.8</version>
</dependency>
```

--------------------------------

### Create Notification - Java

Source: https://zoommax.github.io/OneMessageBot/notifications/notification

Demonstrates how to create and send a notification using the `CreateNotification` class in Java. It specifies the message, target chat ID, notification type, and optionally an image. The `NotificationType` enum controls how the notification appears to the user.

```java
public class example {

    public static void main(String[] args) {
        CreateNotification createNotification = new CreateNotification(
                "Hello notify", // message
                String.valueOf(123456789), // tg_id
                null, // image
                NotificationType.FULL, // notificationType
                null // fileType
        );
        createNotification.run();
    }
}
```

--------------------------------

### Create Buttons using Object with Type Specification (Java)

Source: https://zoommax.github.io/OneMessageBot/keyboard/button

This method allows explicit type specification for Telegram buttons when creating a Button object. It takes 'text', 'action', and 'type' as parameters, where 'type' can be CALLBACK, LINK, or MINI_APP, providing clear definition for the button's functionality.

```java
Button button1 = new Button("I will open a Telegram Mini App", "http://example.com", ButtonType.MINI_APP);
Button button2 = new Button("I will open a link", "http://example.com", ButtonType.LINK);
Button button3 = new Button("I will also open a link", "tg://username", ButtonType.LINK);
Button button4 = new Button("I will perform a callback action", "any_data", ButtonType.CALLBACK);
```

--------------------------------

### Configure Custom Database Type and URL

Source: https://zoommax.github.io/OneMessageBot/database/custom

Sets the database type to custom and provides the base URL for the database connection. Ensure the URL does not include the database name itself.

```java
botSettings.setDbType(DbType.CUSTOM);
botSettings.setDbUrl("jdbc:postgresql://localhost:5432/");
```

--------------------------------

### Gradle Dependency for OneMessageBot

Source: https://zoommax.github.io/OneMessageBot/index

This code snippet demonstrates how to include the OneMessageBot library in your Gradle project. This is a common way to manage dependencies in Gradle-based Java projects.

```gradle
implementation 'space.zoommax:OneMessageBot:2.1.4.8'
```

--------------------------------

### Configure Database Type in OneMessageBot (Java)

Source: https://zoommax.github.io/OneMessageBot/database/overview

Demonstrates how to set the database type for OneMessageBot using the BotSettings class. Supports SQLite, MongoDB, and custom configurations.

```java
botSettings.setDbType(DbType.MONGODB)
// or
botSettings.setDbType(DbType.SQLITE)
// or
botSettings.setDbType(DbType.CUSTOM)
```

--------------------------------

### Manage User Language Settings

Source: https://zoommax.github.io/OneMessageBot/localization/localization

Methods to retrieve and set the language for a specific user. `getUserLanguage` fetches the user's current language setting from the database, while `setUserLanguage` updates it. The language name must correspond to a translation file in the configured directory.

```java
import space.zoommax.utils.lang.UserLanguage; // Assuming UserLanguage is in this package

// Get user's language
String userLang = UserLanguage.getUserLanguage(chatId); 

// Set user's language
UserLanguage.setUserLanguage(chatId, "ru_RU"); // Sets language to Russian, assuming 'ru_RU' translation file exists
```

--------------------------------

### Configure Bot Localization Settings

Source: https://zoommax.github.io/OneMessageBot/localization/localization

Set the default language for the bot and specify the directory path for translation files. This allows the bot to load the correct language resources based on user preferences or default settings. Ensure the specified directory contains valid JSON translation files.

```java
import space.zoommax.BotSettings;

// Assuming botSettings is an instance of BotSettings
botSettings.setDefaultLanguage("default_en_US"); // Sets the default language (e.g., English)
botSettings.setLanguageDirPath("/path/to/translations"); // Sets the path to the translations directory
```

--------------------------------

### Handle Conflicting Keyboard Creation Methods

Source: https://zoommax.github.io/OneMessageBot/keyboard/keyboard

Illustrates the error handling for creating a Telegram keyboard when both the `code` and `keyboardButtons` parameters are provided simultaneously. The `Keyboard.builder` will throw an `IllegalArgumentException` in this scenario, preventing the creation of a keyboard with ambiguous configuration.

```java
IllegalArgumentException("Keyboard cannot have both code and buttons")
```

--------------------------------

### Configure Custom Database Credentials and Name

Source: https://zoommax.github.io/OneMessageBot/database/custom

Sets the username, password, and the specific database name to be used for the custom database connection.

```java
botSettings.setDbUser("user");
botSettings.setDbPassword("password");
botSettings.setDbName("name");
```

--------------------------------

### Configure Custom Database Connection Object

Source: https://zoommax.github.io/OneMessageBot/database/custom

Allows setting a pre-established JDBC `Connection` object directly for the custom database. This bypasses the need for individual URL, user, and password configurations if a connection is already available.

```java
botSettings.setDbConnection(connection);
```

--------------------------------

### Send Documents using DocumentMessage Builder (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/documentmessage

The DocumentMessage class builder constructs messages for sending documents. It supports sending documents via URL, file, or byte array. Optional parameters include chatId, caption, keyboard, onMessageFlag, and notify.

```java
import space.zoommax.view.DocumentMessage;
import java.io.File;

public class example {

    public static void main(String[] args) {
        DocumentMessage documentMessage = DocumentMessage.builder()
                .chatId(123456789)
                .documentAsUrl("https://example.com/document.pdf")
                /*optional
                .documentAsFile(new File("path/to/document.pdf"))
                .documentAsBytes(new byte[]{1,2,3,4,5})
                 */
                .keyboard(Keyboard.builder()
                        .chatId(123456789)
                        .code("{Google;https://google.ru}{Yandex;https://ya.ru}\n" +
                                "{Start;strt}")
                        .build())
                .caption("Hello")
                .onMessageFlag("start")
                .notify(false)
                .build();

        documentMessage.run();
    }
}
```

--------------------------------

### Implement Event Handler with @ViewMessageListener Annotation (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/listener

This Java code demonstrates how to create an event handler class that implements the ViewMessageImpl interface. The class is annotated with @ViewMessageListener to enable the library to broadcast events to it. The onMessage method is implemented to echo text messages back to the chat.

```java
import space.zoommax.utils.ViewMessageListener;
import space.zoommax.view.TextMessage;
import org.telegram.telegrambots.meta.api.objects.Update;
import space.zoommax.view.ViewMessage;
import space.zoommax.view.PhotoSize;

@ViewMessageListener
public class Start implements ViewMessageImpl {

    @Override
    public ViewMessage onMessage(String message, int messageId, long chatId, String onMessageFlag, Update update) {
        return TextMessage.builder()
                .text(message)
                .chatId(chatId)
                .build();
    }

    @Override
    public ViewMessage onCommand(String command, int messageId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onPicture(PhotoSize[] photoSize, String caption, int messageId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onCallbackQuery(String data, int messageId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onInlineQuery(String query, String queryId, long chatId, Update update) {
        return null;
    }

    @Override
    public ViewMessage onChosenInlineResult(String resultId, long queryId, String chatId, Update update) {
        return null;
    }
}
```

--------------------------------

### Create ViewMessage for Update (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/updatemessage

This snippet demonstrates how to create a `ViewMessage` object, specifically a `TextMessage`, which will be used to update an existing message. It sets the text content and the target chat ID. This `ViewMessage` serves as the payload for the update.

```java
ViewMessage viewMessage = TextMessage.builder()
    .text("Hello, world!")
    .chatId(123456789)
    .build();
```

--------------------------------

### Schedule Message Update with Time (Java)

Source: https://zoommax.github.io/OneMessageBot/viewmessage/updatemessage

This Java code shows how to schedule a message update. It creates a `ViewMessage` configured to replace a previous message, sets a specific update time in milliseconds using `System.currentTimeMillis()`, and enables the update via the `needUpdate` flag. The `viewMessageToUpdate` parameter expects a serialized string representation of the message to be replaced.

```java
import space.zoommax.view.TextMessage;

class Example {
    public static void main(String[] args) {
        ViewMessage viewMessage = TextMessage.builder()
                .text("Hello")
                .chatId(123456789)
                .viewMessageToUpdate(viewMessage.toString()) // Assuming 'viewMessage' from the previous snippet is accessible
                .needUpdate(true)
                .updateTime(System.currentTimeMillis() + 10000)
                .build();
        viewMessage.run(); // Or return viewMessage
    }
}
```

--------------------------------

### Create Telegram Keyboard with Formatted Code String

Source: https://zoommax.github.io/OneMessageBot/keyboard/keyboard

Demonstrates creating a Telegram keyboard using a formatted string for button definitions. Buttons are arranged vertically by default. This method relies on the `code` parameter within the `Keyboard.builder`, where new rows are separated by '\n'. Non-button characters outside of curly braces are ignored.

```java
import space.zoommax.utils.keyboard.Keyboard;

Keyboard keyboard = Keyboard.builder()
        .chatId(123456789)
        .code("{I will open a link;http://example.com}\n{I will perform a callback action;any_data}")
        .build();
```

```java
import space.zoommax.utils.keyboard.Keyboard;

Keyboard keyboard = Keyboard.builder()
        .chatId(123456789)
        .code("{I will open a link;http://example.com}{I will perform a callback action;any_data}\n{I will also open a link;tg://username}")
        .build();
```

```java
import space.zoommax.utils.keyboard.Keyboard;

Keyboard keyboard = Keyboard.builder()
        .chatId(123456789)
        .code("{I will open a link;http://example.com}{I will perform a callback action;any_data}\n" +
                "_____>!@_________{I will also open a link;tg://username}______acfd_______")
        .build();
```

--------------------------------

### English Localization Template

Source: https://zoommax.github.io/OneMessageBot/localization/localization

This JSON structure represents the localization template for the English language. It defines key-value pairs for various bot messages and UI elements, which can be modified when creating custom localizations. The structure uses nested objects for organization.

```json
{
  "main": {
    "bot_starting": "Bot starting...",
    "notification": "You have unread notifications",
    "notify_close": "Close"
  },
  "keyboard": {
    "next_button": "➡️",
    "prev_button": "⬅️"
  }
}
```
Tokens:
Raw