ban_chat_member

template<class Agent>
api_result<boolean_t, Agent&&> ban_chat_member(Agent &&agent, ban_chat_member_args_t args)

template<class Agent, class F>
void ban_chat_member(Agent &&agent, ban_chat_member_args_t args, F &&callback)

agent is any object satisfying agent concept.

callback is any callable object accepting expected<boolean_t>.

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

struct ban_chat_member_args_t

Arguments that should be passed to ban_chat_member().

variant_t<integer_t, string_t> chat_id

Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

integer_t user_id

Unique identifier of the target user

optional_t<integer_t> until_date

Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

optional_t<boolean_t> revoke_messages

Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.