Telegram.Bot.API.Methods.UnbanChatMember

Documentation

data UnbanChatMemberRequest

Request parameters for unbanChatMember.

Constructors

UnbanChatMemberRequest

Fields

• unbanChatMemberChatId :: SomeChatId

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

• unbanChatMemberUserId :: UserId

  Unique identifier of the target user

• unbanChatMemberOnlyIfBanned :: Maybe Bool

  Do nothing if the user is not banned

Instances

FromJSON UnbanChatMemberRequest

Defined in Telegram.Bot.API.Methods.UnbanChatMember

Methods

parseJSON :: Value -> Parser UnbanChatMemberRequest

parseJSONList :: Value -> Parser [UnbanChatMemberRequest]

omittedField :: Maybe UnbanChatMemberRequest

ToJSON UnbanChatMemberRequest

Defined in Telegram.Bot.API.Methods.UnbanChatMember

Methods

toJSON :: UnbanChatMemberRequest -> Value

toEncoding :: UnbanChatMemberRequest -> Encoding

toJSONList :: [UnbanChatMemberRequest] -> Value

toEncodingList :: [UnbanChatMemberRequest] -> Encoding

omitField :: UnbanChatMemberRequest -> Bool

Generic UnbanChatMemberRequest

Defined in Telegram.Bot.API.Methods.UnbanChatMember

Associated Types

type Rep UnbanChatMemberRequest :: Type -> Type

Methods

from :: UnbanChatMemberRequest -> Rep UnbanChatMemberRequest x

to :: Rep UnbanChatMemberRequest x -> UnbanChatMemberRequest

type Rep UnbanChatMemberRequest

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)))))

type UnbanChatMember = "unbanChatMember" :> (ReqBody '[JSON] UnbanChatMemberRequest :> Post '[JSON] (Response Bool))

unbanChatMember :: UnbanChatMemberRequest -> ClientM (Response Bool)

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.

defUnbanChatMember :: SomeChatId -> UserId -> UnbanChatMemberRequest