raito.plugins.roles.providers.protocol module

class raito.plugins.roles.providers.protocol.IRoleProvider(*args, **kwargs)

Базовые классы: Protocol

Protocol for providers that manage user roles.

async get_role(bot_id, user_id)

Get the role for a specific user.

Параметры:

• bot_id (int) – The Telegram bot ID

• user_id (int) – The Telegram user ID

Результат:

The role slug or None if not found

Тип результата:

str | None

async set_role(bot_id, user_id, role_slug)

Set the role for a specific user.

Параметры:

• bot_id (int) – The Telegram bot ID

• user_id (int) – The Telegram user ID

• role_slug (str) – The role slug to assign

Тип результата:

None

async remove_role(bot_id, user_id)

Remove the role for a specific user.

Параметры:

• bot_id (int) – The Telegram bot ID

• user_id (int) – The Telegram user ID

Тип результата:

None

async migrate()

Initialize the storage backend (create tables, etc.).

Тип результата:

None

async get_users(bot_id, role_slug)

Get all users with a specific role.

Параметры:

• bot_id (int) – The Telegram bot ID

• role_slug (str) – The role slug to check for

Результат:

A list of Telegram user IDs

Тип результата:

list[int]