Functions

Coding in Bota, you can use all the usual PHP functions except file_get_contents() and eval()

Available Functions

• runCommand
• handleCommand
• setProperty
• getProperty
• banChat
• unbanChat
• bulk
• runAfter

runCommand

runCommand can be used to run another command.

// run other command
$Bot->runCommand("/deposit");

// run other command with options
$Bot->runCommand("/deposit", ['options' => ['user_id' => 0123456789,'currency' => 'TRX']]);

// in second command /deposit:
$Bot->sendMessage(["chat_id" => $options->user_id, "text" => "You will deposit: " . $options->currency]);

handleCommand

handleCommand AKA waitForAnswer can be use to wait for user response or answer

// handle another command
$Bot->handleCommand("/amount");

// handle another command with options
$Bot->handleCommand("/amount", ['options' => ['user_id' => 0123456789,'currency' => 'TRX']]);

// in second command /amount:
$Bot->sendMessage(["chat_id" => $options->user_id, "text" => "You will deposit: " . $options->currency]);

setProperty

setProperty function can be used to set property with name for bot.

// main class
$Bot->setProperty($chat_id, "name", "value"); // set property for the specific user

// User object
$User->conversation("name", "value"); // set property for the current user

getProperty

getProperty function can be use to read property with name. Name is case sensitive.

// main class
$Bot->getProperty($chat_id, "name"); // get property value for the specific user

// User object
$User->conversation("name"); // get property value for the current user

banChat

Use this function to ban chat id or user in your bot.

<?php
$Bot->banChat($chat_id);

You can also pass reason message to send to the banned chat id (optional)

<?php
$reason = "Sorry, you have been banned for using multiple account";
$Bot->banChat($chat_id, $reason);

unbanChat

Use this function to unban banned chat id in your bot.

<?php
$Bot->unbanChat($chat_id);

bulk

bulk method also known as broadcast, it can be used to send message to all users of a bot.

Parameters:

• $method (string): The name of the Telegram Bot API method to call (e.g. “sendMessage”).

• $parameters (array): An array of parameters to pass to the Telegram Bot API method.

<?php
$result = $Bot->bulk("sendMessage", [
    "text" => "Hello, world!"
]);
$User->sendMessage($result);

runAfter

runAfter method is used to schedule a command to run after a specified number of minutes (1 to 44640). It can be used in bots to automate tasks and execute commands at a later time.

• Parameters

The method takes in a single parameter, $settings, which is an array of options that specify the details of the command to be scheduled. The following options are available:

$settings = [
    'command' => '',    // The name of the command to run after the specified number of minutes.
    'minutes' => '',    // The number of minutes after which the command should be run.
    'label' => '',      // (Optional) A label to identify the scheduled task.
    'options' => []     // (Optional) An array of additional options to pass to the command.
];

• Usage

$settings = [
    'command' => 'my_command',    // Replace with the name of your command.
    'minutes' => 60,              // Replace with the number of minutes after which the command should run.
    'label' => 'my_label',        // (Optional) Replace with a label to identify the scheduled task.
    'options' => [
        'param1' => 'value1',
        'param2' => 'value2',
    ],                            // (Optional) Replace with an array of additional options to pass to the command.
];
$id = $Bot->runAfter($settings);
if ($id) {
    // you can save this id if you want to cancel scheduled command in future.
    $User->sendMessage($id);
} else {
    $User->sendMessage("Error scheduling command.");
}

• Canceling a Scheduled Command

To cancel a scheduled command, you can pass in an additional option cancel with the value true, along with either the id or label of the scheduled task to cancel:

$settings = [
    'cancel' => true,    // Set to true to cancel the scheduled task.
    'id' => 123,         // Replace with the ID of the scheduled task to cancel.
    // or
    'label' => 'my_label'// Replace with the label of the scheduled task to cancel.
];
$result = $Bot->runAfter($settings);
if ($result) {
    $User->sendMessage("Command canceled successfully!");
} else {
    $User->sendMessage("Error canceling command.");
}

Note that you must provide either the id or label of the scheduled task to cancel, and not both.