Telegram.Bot.API.Methods.PromoteChatMember

promoteChatMember

data PromoteChatMemberRequest

Request parameters for promoteChatMember.

Constructors

PromoteChatMemberRequest

Fields

• promoteChatMemberChatId :: SomeChatId

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

• promoteChatMemberUserId :: UserId

  Unique identifier of the target user.

• promoteChatMemberIsAnonymous :: Maybe Bool

  Pass True, if the administrator's presence in the chat is hidden.

• promoteChatMemberCanManageChat :: Maybe Bool

  Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege.

• promoteChatMemberCanPostMessages :: Maybe Bool

  Pass True, if the administrator can create channel posts, channels only.

• promoteChatMemberCanEditMessages :: Maybe Bool

  Pass True, if the administrator can edit messages of other users and can pin messages, channels only.

• promoteChatMemberCanDeleteMessages :: Maybe Bool

  Pass True, if the administrator can delete messages of other users.

• promoteChatMemberCanManageVideoChats :: Maybe Bool

  Pass True, if the administrator can manage video chats.

• promoteChatMemberCanRestrictMembers :: Maybe Bool

  Pass True, if the administrator can restrict, ban or unban chat members.

• promoteChatMemberCanPromoteMembers :: Maybe Bool

  Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him).

• promoteChatMemberCanChangeInfo :: Maybe Bool

  Pass True, if the administrator can change chat title, photo and other settings.

• promoteChatMemberCanInviteUsers :: Maybe Bool

  Pass True, if the administrator can invite new users to the chat.

• promoteChatMemberCanPinMessages :: Maybe Bool

  Pass True, if the administrator can pin messages, supergroups only.

• promoteChatMemberCanManageTopics :: Maybe Bool

  Pass True, if the user is allowed to create, rename, close, and reopen forum topics, supergroups only.

Instances

FromJSON PromoteChatMemberRequest

Defined in Telegram.Bot.API.Methods.PromoteChatMember

Methods

parseJSON :: Value -> Parser PromoteChatMemberRequest

parseJSONList :: Value -> Parser [PromoteChatMemberRequest]

ToJSON PromoteChatMemberRequest

Defined in Telegram.Bot.API.Methods.PromoteChatMember

Methods

toJSON :: PromoteChatMemberRequest -> Value

toEncoding :: PromoteChatMemberRequest -> Encoding

toJSONList :: [PromoteChatMemberRequest] -> Value

toEncodingList :: [PromoteChatMemberRequest] -> Encoding

Generic PromoteChatMemberRequest

Defined in Telegram.Bot.API.Methods.PromoteChatMember

Associated Types

type Rep PromoteChatMemberRequest :: Type -> Type

Methods

from :: PromoteChatMemberRequest -> Rep PromoteChatMemberRequest x

to :: Rep PromoteChatMemberRequest x -> PromoteChatMemberRequest

type Rep PromoteChatMemberRequest

Defined in Telegram.Bot.API.Methods.PromoteChatMember

type Rep PromoteChatMemberRequest = D1 ('MetaData "PromoteChatMemberRequest" "Telegram.Bot.API.Methods.PromoteChatMember" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "PromoteChatMemberRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "promoteChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "promoteChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "promoteChatMemberIsAnonymous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "promoteChatMemberCanManageChat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promoteChatMemberCanPostMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "promoteChatMemberCanEditMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promoteChatMemberCanDeleteMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "promoteChatMemberCanManageVideoChats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "promoteChatMemberCanRestrictMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promoteChatMemberCanPromoteMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "promoteChatMemberCanChangeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promoteChatMemberCanInviteUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "promoteChatMemberCanPinMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promoteChatMemberCanManageTopics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))

type PromoteChatMember = "promoteChatMember" :> (ReqBody '[JSON] PromoteChatMemberRequest :> Post '[JSON] (Response Bool))

promoteChatMember :: PromoteChatMemberRequest -> ClientM (Response Bool)

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.