telegram-bot-api-7.3.1: Easy to use library for building Telegram bots. Exports Telegram Bot API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Telegram.Bot.API.Methods.UnbanChatMember

Synopsis

Documentation

data UnbanChatMemberRequest Source #

Request parameters for unbanChatMember.

Constructors

UnbanChatMemberRequest 

Fields

Instances

Instances details
FromJSON UnbanChatMemberRequest Source # 
Instance details

Defined in Telegram.Bot.API.Methods.UnbanChatMember

ToJSON UnbanChatMemberRequest Source # 
Instance details

Defined in Telegram.Bot.API.Methods.UnbanChatMember

Generic UnbanChatMemberRequest Source # 
Instance details

Defined in Telegram.Bot.API.Methods.UnbanChatMember

Associated Types

type Rep UnbanChatMemberRequest :: Type -> Type #

type Rep UnbanChatMemberRequest Source # 
Instance details

Defined in Telegram.Bot.API.Methods.UnbanChatMember

type Rep UnbanChatMemberRequest = D1 ('MetaData "UnbanChatMemberRequest" "Telegram.Bot.API.Methods.UnbanChatMember" "telegram-bot-api-7.3.1-HIEcormdC3TJNwe3u54c0g" 'False) (C1 ('MetaCons "UnbanChatMemberRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unbanChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "unbanChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "unbanChatMemberOnlyIfBanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

unbanChatMember :: UnbanChatMemberRequest -> ClientM (Response Bool) Source #

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.