Module silbot.objects

Here there are some extra methods for types objects

Expand source code 
"""
## Here there are some extra methods for [types](types.m.html) objects
"""


class InlineKeyboardMarkup:
    """types.InlineKeyboardMarkup will inherit this class' methods"""

    def __init__(self, inline_keyboard=None):
        if inline_keyboard is None:
            inline_keyboard = []
        self.inline_keyboard = inline_keyboard

    def addLine(self, line: list):
        """Adds a line to the given keyboard

        Args:

        - `line` (`list`): list of InlineKeyboardButtons
        """
        self.inline_keyboard.append(line)

    def removeLine(self, line_number: int):
        """Removes a line from the given keyboard

        Args:

        - `line_number` (`int`): Number of the line (from 0) to remove
        """
        self.inline_keyboard.pop(line_number)


class ReplyKeyboardMarkup:
    """types.KeyboardMarkup will inherit this class' methods"""

    def __init__(self, keyboard=None):
        if keyboard is None:
            keyboard = []
        self.keyboard = keyboard

    def addLine(self, line: list):
        """Adds a line to the given keyboard

        Args:

        - `line` (`list`): list of KeyboardButtons
        """
        self.keyboard.append(line)

    def removeLine(self, line_number):
        """Removes a line from the given keyboard

        Args:

        - `line_number` (`int`): Number of the line (from 0) to remove
        """
        self.keyboard.pop(line_number)


class CallbackQuery:
    """types.CallbackQuery will inherit this class' methods"""
    def __init__(self, id, user_id):
        self.id = id
        self.user_id = user_id

    def answer(self, bot, text=None, show_alert=None, url=None, cache_time=None):
        """Sends a answerCallbackQuery request to botApi for the given callback

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `text` :`str` Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
        - `show_alert` :`bool` If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
        - `url` :`str` URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game � note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
        - `cache_time` :`int` The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

        **Returns:**

        - A `tuple`, on success a `bool` as first member and a botApiResponse object as second member
        """
        return bot.answerCallbackQuery(self.id, text, show_alert, url, cache_time)


class User:
    """types.User will inherit this class' methods"""
    def __init__(self, id, type):
        self.id = id
        self.type = type

    def setDBManager(self, db_manager):
        """Sets a default DB Manager for the given object

        Args:

        - `db_manager`: An object that inherits database.DatabaseManager methods
        """
        self.db_manager = db_manager

    def save(self, db_manager=None, *additional_arguments):
        """Saves a user in the database, **This method uses addUser method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.addUser()`
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.addUser(self, additional_arguments)

    def getInfo(self, db_manager=None):
        """Gets user's information from the database, **This method uses getInfo method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.getInfo(self)
        return self.db

    def setColumn(self, column: str, value, db_manager=None):
        """Sets a given column to a given value for this user in the database, **This method uses setColumn method from `DatabaseManager`**

        Args:

        - `column` (`str`): Column to set
        - `value`: Value to set
        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        db_manager.setColumn(self, column, value)

    def isMember(self, bot, chat_id):
        """Sends a getChatMember request to botApi and returns if the current user is a member of a given group

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `chat_id` (`int`): The ID of the chat where to check if a user is member.

        **Returns**
        - `bool` True if the user is in the chat, False otherwise
        """
        obj, response = bot.getChatMember(chat_id, self.id)
        if response.ok:
            if obj.status == "left" or obj.status == "kicked" or (
                    obj.status == "restricted" and obj.is_member is False):
                return False
            else:
                return True
        return False

    def isAdmin(self, bot, chat_id):
        """Sends a getChatMember request to botApi and returns if the current user is a admin of a given group

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `chat_id` (`int`): The ID of the chat where to check if a user is admin.

        **Returns**
        - `bool` True if the user is admin in the chat, False otherwise
        """
        obj, response = bot.getChatMember(chat_id, self.id)
        if response.ok:
            if obj.status == "administrator" or obj.status == "creator":
                return True
        return False


class Chat:
    """types.Chat will inherit this class' methods"""
    def __init__(self, id, type):
        self.id = id
        self.type = type

    def setDBManager(self, db_manager):
        """Sets a default DB Manager for the given object

        Args:

        - `db_manager`: An object that inherits database.DatabaseManager methods
        """
        self.db_manager = db_manager

    def save(self, db_manager=None, *additional_arguments):
        """Saves a chat in the database, **This method uses addChat method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set


        This automatically sets `self.db` attribute with the value of `DatabaseManager.addChat()`
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.addChat(self, additional_arguments)

    def getInfo(self, db_manager=None):
        """Gets chat's information from the database, **This method uses getInfo method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.getInfo(self)

    def setColumn(self, column, value, db_manager=None):
        """Edits database's column for a user

        **Args:**

        - `chat` (`types.Chat`or `types.User`): Chat to edit a column in database
        - `column` (`str`): Name of the column to edit
        - `value` (`str`): Value to set
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        db_manager.setColumn(self, column, value)

    def isMember(self, bot, user_id):
        """Sends a getChatMember request to botApi and returns if a given user is in the current chat

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `user_id` (`int`): The ID of the user to check if is a member.

        **Returns**
        - `bool` True if the user is in the chat, False otherwise
        """
        obj, response = bot.getChatMember(self.id, user_id)
        if response.ok:
            if obj.status == "left" or obj.status == "kicked" or (
                    obj.status == "restricted" and obj.is_member is False):
                return False
            else:
                return True
        return False

    def isAdmin(self, bot, user_id):
        """Sends a getChatMember request to botApi and returns if a given user is admin in the current chat

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `user_id` (`int`): The ID of the user to check if is an admin.

        **Returns**
        - `bool` True if the user is an admin, False otherwise
        """
        obj, response = bot.getChatMember(self.id, user_id)
        if response.ok:
            if obj.status == "administrator" or obj.status == "creator":
                return True
        return False

Classes

class CallbackQuery (id, user_id)

types.CallbackQuery will inherit this class' methods

Expand source code 
class CallbackQuery:
    """types.CallbackQuery will inherit this class' methods"""
    def __init__(self, id, user_id):
        self.id = id
        self.user_id = user_id

    def answer(self, bot, text=None, show_alert=None, url=None, cache_time=None):
        """Sends a answerCallbackQuery request to botApi for the given callback

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `text` :`str` Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
        - `show_alert` :`bool` If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
        - `url` :`str` URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game � note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
        - `cache_time` :`int` The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

        **Returns:**

        - A `tuple`, on success a `bool` as first member and a botApiResponse object as second member
        """
        return bot.answerCallbackQuery(self.id, text, show_alert, url, cache_time)

Subclasses

Methods

def answer(self, bot, text=None, show_alert=None, url=None, cache_time=None)

Sends a answerCallbackQuery request to botApi for the given callback

Args:

  • bot (silbot.botapi.botApi): bot object to perform the request
  • text :str Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
  • show_alert :bool If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
  • url :str URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game � note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
  • cache_time :int The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

Returns:

  • A tuple, on success a bool as first member and a botApiResponse object as second member
Expand source code 
def answer(self, bot, text=None, show_alert=None, url=None, cache_time=None):
    """Sends a answerCallbackQuery request to botApi for the given callback

    - - - - -
    **Args**:

    - `bot` (`silbot.botapi.botApi`): bot object to perform the request
    - `text` :`str` Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
    - `show_alert` :`bool` If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
    - `url` :`str` URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game � note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
    - `cache_time` :`int` The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

    **Returns:**

    - A `tuple`, on success a `bool` as first member and a botApiResponse object as second member
    """
    return bot.answerCallbackQuery(self.id, text, show_alert, url, cache_time)
class Chat (id, type)

types.Chat will inherit this class' methods

Expand source code 
class Chat:
    """types.Chat will inherit this class' methods"""
    def __init__(self, id, type):
        self.id = id
        self.type = type

    def setDBManager(self, db_manager):
        """Sets a default DB Manager for the given object

        Args:

        - `db_manager`: An object that inherits database.DatabaseManager methods
        """
        self.db_manager = db_manager

    def save(self, db_manager=None, *additional_arguments):
        """Saves a chat in the database, **This method uses addChat method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set


        This automatically sets `self.db` attribute with the value of `DatabaseManager.addChat()`
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.addChat(self, additional_arguments)

    def getInfo(self, db_manager=None):
        """Gets chat's information from the database, **This method uses getInfo method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.getInfo(self)

    def setColumn(self, column, value, db_manager=None):
        """Edits database's column for a user

        **Args:**

        - `chat` (`types.Chat`or `types.User`): Chat to edit a column in database
        - `column` (`str`): Name of the column to edit
        - `value` (`str`): Value to set
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        db_manager.setColumn(self, column, value)

    def isMember(self, bot, user_id):
        """Sends a getChatMember request to botApi and returns if a given user is in the current chat

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `user_id` (`int`): The ID of the user to check if is a member.

        **Returns**
        - `bool` True if the user is in the chat, False otherwise
        """
        obj, response = bot.getChatMember(self.id, user_id)
        if response.ok:
            if obj.status == "left" or obj.status == "kicked" or (
                    obj.status == "restricted" and obj.is_member is False):
                return False
            else:
                return True
        return False

    def isAdmin(self, bot, user_id):
        """Sends a getChatMember request to botApi and returns if a given user is admin in the current chat

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `user_id` (`int`): The ID of the user to check if is an admin.

        **Returns**
        - `bool` True if the user is an admin, False otherwise
        """
        obj, response = bot.getChatMember(self.id, user_id)
        if response.ok:
            if obj.status == "administrator" or obj.status == "creator":
                return True
        return False

Subclasses

Methods

def getInfo(self, db_manager=None)

Gets chat's information from the database, This method uses getInfo method from DatabaseManager

Args:

  • db_manager (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

This automatically sets self.db attribute with the value of DatabaseManager.getInfo() and returns it

Expand source code 
def getInfo(self, db_manager=None):
    """Gets chat's information from the database, **This method uses getInfo method from `DatabaseManager`**

    Args:

    - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

    This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    self.db = db_manager.getInfo(self)
def isAdmin(self, bot, user_id)

Sends a getChatMember request to botApi and returns if a given user is admin in the current chat

Args:

  • bot (silbot.botapi.botApi): bot object to perform the request
  • user_id (int): The ID of the user to check if is an admin.

Returns - bool True if the user is an admin, False otherwise

Expand source code 
def isAdmin(self, bot, user_id):
    """Sends a getChatMember request to botApi and returns if a given user is admin in the current chat

    - - - - -
    **Args**:

    - `bot` (`silbot.botapi.botApi`): bot object to perform the request
    - `user_id` (`int`): The ID of the user to check if is an admin.

    **Returns**
    - `bool` True if the user is an admin, False otherwise
    """
    obj, response = bot.getChatMember(self.id, user_id)
    if response.ok:
        if obj.status == "administrator" or obj.status == "creator":
            return True
    return False
def isMember(self, bot, user_id)

Sends a getChatMember request to botApi and returns if a given user is in the current chat

Args:

  • bot (silbot.botapi.botApi): bot object to perform the request
  • user_id (int): The ID of the user to check if is a member.

Returns - bool True if the user is in the chat, False otherwise

Expand source code 
def isMember(self, bot, user_id):
    """Sends a getChatMember request to botApi and returns if a given user is in the current chat

    - - - - -
    **Args**:

    - `bot` (`silbot.botapi.botApi`): bot object to perform the request
    - `user_id` (`int`): The ID of the user to check if is a member.

    **Returns**
    - `bool` True if the user is in the chat, False otherwise
    """
    obj, response = bot.getChatMember(self.id, user_id)
    if response.ok:
        if obj.status == "left" or obj.status == "kicked" or (
                obj.status == "restricted" and obj.is_member is False):
            return False
        else:
            return True
    return False
def save(self, db_manager=None, *additional_arguments)

Saves a chat in the database, This method uses addChat method from DatabaseManager

Args:

  • db_manager (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

This automatically sets self.db attribute with the value of DatabaseManager.addChat()

Expand source code 
def save(self, db_manager=None, *additional_arguments):
    """Saves a chat in the database, **This method uses addChat method from `DatabaseManager`**

    Args:

    - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set


    This automatically sets `self.db` attribute with the value of `DatabaseManager.addChat()`
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    self.db = db_manager.addChat(self, additional_arguments)
def setColumn(self, column, value, db_manager=None)

Edits database's column for a user

Args:

  • chat (types.Chator types.User): Chat to edit a column in database
  • column (str): Name of the column to edit
  • value (str): Value to set
Expand source code 
def setColumn(self, column, value, db_manager=None):
    """Edits database's column for a user

    **Args:**

    - `chat` (`types.Chat`or `types.User`): Chat to edit a column in database
    - `column` (`str`): Name of the column to edit
    - `value` (`str`): Value to set
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    db_manager.setColumn(self, column, value)
def setDBManager(self, db_manager)

Sets a default DB Manager for the given object

Args:

  • db_manager: An object that inherits database.DatabaseManager methods
Expand source code 
def setDBManager(self, db_manager):
    """Sets a default DB Manager for the given object

    Args:

    - `db_manager`: An object that inherits database.DatabaseManager methods
    """
    self.db_manager = db_manager
class InlineKeyboardMarkup (inline_keyboard=None)

types.InlineKeyboardMarkup will inherit this class' methods

Expand source code 
class InlineKeyboardMarkup:
    """types.InlineKeyboardMarkup will inherit this class' methods"""

    def __init__(self, inline_keyboard=None):
        if inline_keyboard is None:
            inline_keyboard = []
        self.inline_keyboard = inline_keyboard

    def addLine(self, line: list):
        """Adds a line to the given keyboard

        Args:

        - `line` (`list`): list of InlineKeyboardButtons
        """
        self.inline_keyboard.append(line)

    def removeLine(self, line_number: int):
        """Removes a line from the given keyboard

        Args:

        - `line_number` (`int`): Number of the line (from 0) to remove
        """
        self.inline_keyboard.pop(line_number)

Subclasses

Methods

def addLine(self, line: list)

Adds a line to the given keyboard

Args:

  • line (list): list of InlineKeyboardButtons
Expand source code 
def addLine(self, line: list):
    """Adds a line to the given keyboard

    Args:

    - `line` (`list`): list of InlineKeyboardButtons
    """
    self.inline_keyboard.append(line)
def removeLine(self, line_number: int)

Removes a line from the given keyboard

Args:

  • line_number (int): Number of the line (from 0) to remove
Expand source code 
def removeLine(self, line_number: int):
    """Removes a line from the given keyboard

    Args:

    - `line_number` (`int`): Number of the line (from 0) to remove
    """
    self.inline_keyboard.pop(line_number)
class ReplyKeyboardMarkup (keyboard=None)

types.KeyboardMarkup will inherit this class' methods

Expand source code 
class ReplyKeyboardMarkup:
    """types.KeyboardMarkup will inherit this class' methods"""

    def __init__(self, keyboard=None):
        if keyboard is None:
            keyboard = []
        self.keyboard = keyboard

    def addLine(self, line: list):
        """Adds a line to the given keyboard

        Args:

        - `line` (`list`): list of KeyboardButtons
        """
        self.keyboard.append(line)

    def removeLine(self, line_number):
        """Removes a line from the given keyboard

        Args:

        - `line_number` (`int`): Number of the line (from 0) to remove
        """
        self.keyboard.pop(line_number)

Subclasses

Methods

def addLine(self, line: list)

Adds a line to the given keyboard

Args:

  • line (list): list of KeyboardButtons
Expand source code 
def addLine(self, line: list):
    """Adds a line to the given keyboard

    Args:

    - `line` (`list`): list of KeyboardButtons
    """
    self.keyboard.append(line)
def removeLine(self, line_number)

Removes a line from the given keyboard

Args:

  • line_number (int): Number of the line (from 0) to remove
Expand source code 
def removeLine(self, line_number):
    """Removes a line from the given keyboard

    Args:

    - `line_number` (`int`): Number of the line (from 0) to remove
    """
    self.keyboard.pop(line_number)
class User (id, type)

types.User will inherit this class' methods

Expand source code 
class User:
    """types.User will inherit this class' methods"""
    def __init__(self, id, type):
        self.id = id
        self.type = type

    def setDBManager(self, db_manager):
        """Sets a default DB Manager for the given object

        Args:

        - `db_manager`: An object that inherits database.DatabaseManager methods
        """
        self.db_manager = db_manager

    def save(self, db_manager=None, *additional_arguments):
        """Saves a user in the database, **This method uses addUser method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.addUser()`
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.addUser(self, additional_arguments)

    def getInfo(self, db_manager=None):
        """Gets user's information from the database, **This method uses getInfo method from `DatabaseManager`**

        Args:

        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

        This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        self.db = db_manager.getInfo(self)
        return self.db

    def setColumn(self, column: str, value, db_manager=None):
        """Sets a given column to a given value for this user in the database, **This method uses setColumn method from `DatabaseManager`**

        Args:

        - `column` (`str`): Column to set
        - `value`: Value to set
        - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set
        """
        if db_manager is None:
            if not hasattr(self, "db_manager") or self.db_manager is None:
                return False
            else:
                db_manager = self.db_manager
        db_manager.setColumn(self, column, value)

    def isMember(self, bot, chat_id):
        """Sends a getChatMember request to botApi and returns if the current user is a member of a given group

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `chat_id` (`int`): The ID of the chat where to check if a user is member.

        **Returns**
        - `bool` True if the user is in the chat, False otherwise
        """
        obj, response = bot.getChatMember(chat_id, self.id)
        if response.ok:
            if obj.status == "left" or obj.status == "kicked" or (
                    obj.status == "restricted" and obj.is_member is False):
                return False
            else:
                return True
        return False

    def isAdmin(self, bot, chat_id):
        """Sends a getChatMember request to botApi and returns if the current user is a admin of a given group

        - - - - -
        **Args**:

        - `bot` (`silbot.botapi.botApi`): bot object to perform the request
        - `chat_id` (`int`): The ID of the chat where to check if a user is admin.

        **Returns**
        - `bool` True if the user is admin in the chat, False otherwise
        """
        obj, response = bot.getChatMember(chat_id, self.id)
        if response.ok:
            if obj.status == "administrator" or obj.status == "creator":
                return True
        return False

Subclasses

Methods

def getInfo(self, db_manager=None)

Gets user's information from the database, This method uses getInfo method from DatabaseManager

Args:

  • db_manager (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

This automatically sets self.db attribute with the value of DatabaseManager.getInfo() and returns it

Expand source code 
def getInfo(self, db_manager=None):
    """Gets user's information from the database, **This method uses getInfo method from `DatabaseManager`**

    Args:

    - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

    This automatically sets `self.db` attribute with the value of `DatabaseManager.getInfo()` and returns it
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    self.db = db_manager.getInfo(self)
    return self.db
def isAdmin(self, bot, chat_id)

Sends a getChatMember request to botApi and returns if the current user is a admin of a given group

Args:

  • bot (silbot.botapi.botApi): bot object to perform the request
  • chat_id (int): The ID of the chat where to check if a user is admin.

Returns - bool True if the user is admin in the chat, False otherwise

Expand source code 
def isAdmin(self, bot, chat_id):
    """Sends a getChatMember request to botApi and returns if the current user is a admin of a given group

    - - - - -
    **Args**:

    - `bot` (`silbot.botapi.botApi`): bot object to perform the request
    - `chat_id` (`int`): The ID of the chat where to check if a user is admin.

    **Returns**
    - `bool` True if the user is admin in the chat, False otherwise
    """
    obj, response = bot.getChatMember(chat_id, self.id)
    if response.ok:
        if obj.status == "administrator" or obj.status == "creator":
            return True
    return False
def isMember(self, bot, chat_id)

Sends a getChatMember request to botApi and returns if the current user is a member of a given group

Args:

  • bot (silbot.botapi.botApi): bot object to perform the request
  • chat_id (int): The ID of the chat where to check if a user is member.

Returns - bool True if the user is in the chat, False otherwise

Expand source code 
def isMember(self, bot, chat_id):
    """Sends a getChatMember request to botApi and returns if the current user is a member of a given group

    - - - - -
    **Args**:

    - `bot` (`silbot.botapi.botApi`): bot object to perform the request
    - `chat_id` (`int`): The ID of the chat where to check if a user is member.

    **Returns**
    - `bool` True if the user is in the chat, False otherwise
    """
    obj, response = bot.getChatMember(chat_id, self.id)
    if response.ok:
        if obj.status == "left" or obj.status == "kicked" or (
                obj.status == "restricted" and obj.is_member is False):
            return False
        else:
            return True
    return False
def save(self, db_manager=None, *additional_arguments)

Saves a user in the database, This method uses addUser method from DatabaseManager

Args:

  • db_manager (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

This automatically sets self.db attribute with the value of DatabaseManager.addUser()

Expand source code 
def save(self, db_manager=None, *additional_arguments):
    """Saves a user in the database, **This method uses addUser method from `DatabaseManager`**

    Args:

    - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set

    This automatically sets `self.db` attribute with the value of `DatabaseManager.addUser()`
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    self.db = db_manager.addUser(self, additional_arguments)
def setColumn(self, column: str, value, db_manager=None)

Sets a given column to a given value for this user in the database, This method uses setColumn method from DatabaseManager

Args:

  • column (str): Column to set
  • value: Value to set
  • db_manager (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set
Expand source code 
def setColumn(self, column: str, value, db_manager=None):
    """Sets a given column to a given value for this user in the database, **This method uses setColumn method from `DatabaseManager`**

    Args:

    - `column` (`str`): Column to set
    - `value`: Value to set
    - `db_manager` (An object that inherits database.DatabaseManager methods): This is optional if a default DB Manager for this object is already set
    """
    if db_manager is None:
        if not hasattr(self, "db_manager") or self.db_manager is None:
            return False
        else:
            db_manager = self.db_manager
    db_manager.setColumn(self, column, value)
def setDBManager(self, db_manager)

Sets a default DB Manager for the given object

Args:

  • db_manager: An object that inherits database.DatabaseManager methods
Expand source code 
def setDBManager(self, db_manager):
    """Sets a default DB Manager for the given object

    Args:

    - `db_manager`: An object that inherits database.DatabaseManager methods
    """
    self.db_manager = db_manager