Telegram.Bot.API.Methods.RestrictChatMember

restrictChatMember

data RestrictChatMemberRequest

Request parameters for restrictChatMember.

Constructors

RestrictChatMemberRequest

Fields

• restrictChatMemberChatId :: SomeChatId

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

• restrictChatMemberUserId :: UserId

  Unique identifier of the target user.

• restrictChatMemberPermissions :: ChatPermissions

  A JSON-serialized object for new user permissions.

• restrictChatMemberUseIndependentChatPermissions :: Maybe Bool

  Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

• restrictChatMemberUntilDate :: Maybe Int

  Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.

Instances

FromJSON RestrictChatMemberRequest

Defined in Telegram.Bot.API.Methods.RestrictChatMember

Methods

parseJSON :: Value -> Parser RestrictChatMemberRequest

parseJSONList :: Value -> Parser [RestrictChatMemberRequest]

ToJSON RestrictChatMemberRequest

Defined in Telegram.Bot.API.Methods.RestrictChatMember

Methods

toJSON :: RestrictChatMemberRequest -> Value

toEncoding :: RestrictChatMemberRequest -> Encoding

toJSONList :: [RestrictChatMemberRequest] -> Value

toEncodingList :: [RestrictChatMemberRequest] -> Encoding

Generic RestrictChatMemberRequest

Defined in Telegram.Bot.API.Methods.RestrictChatMember

Associated Types

type Rep RestrictChatMemberRequest :: Type -> Type

Methods

from :: RestrictChatMemberRequest -> Rep RestrictChatMemberRequest x

to :: Rep RestrictChatMemberRequest x -> RestrictChatMemberRequest

type Rep RestrictChatMemberRequest

Defined in Telegram.Bot.API.Methods.RestrictChatMember

type Rep RestrictChatMemberRequest = D1 ('MetaData "RestrictChatMemberRequest" "Telegram.Bot.API.Methods.RestrictChatMember" "telegram-bot-api-6.7-8B5O9jcStFh8aacJiwZZeM" 'False) (C1 ('MetaCons "RestrictChatMemberRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restrictChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "restrictChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId)) :*: (S1 ('MetaSel ('Just "restrictChatMemberPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatPermissions) :*: (S1 ('MetaSel ('Just "restrictChatMemberUseIndependentChatPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "restrictChatMemberUntilDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))))

type RestrictChatMember = "restrictChatMember" :> (ReqBody '[JSON] RestrictChatMemberRequest :> Post '[JSON] (Response Bool))

restrictChatMember :: RestrictChatMemberRequest -> ClientM (Response Bool)

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

defRestrictChatMember :: SomeChatId -> UserId -> ChatPermissions -> RestrictChatMemberRequest