Safe Haskell	Safe-Inferred
Language	Haskell2010

Telegram.Bot.API.Methods.CreateChatInviteLink

Contents

createChatInviteLink

Synopsis

`createChatInviteLink`

data CreateChatInviteLinkRequest Source #

Request parameters for createChatInviteLink.

Constructors

CreateChatInviteLinkRequest

Fields

createChatInviteLinkChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
createChatInviteLinkName :: Maybe Text
Invite link name; 0-32 characters
createChatInviteLinkExpireDate :: Maybe Integer
Point in time (Unix timestamp) when the link will expire
createChatInviteLinkMemberLimit :: Maybe Int
Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
createChatInviteLinkCreatesJoinRequest :: Maybe Bool
True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

Instances

Instances details

FromJSON CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.CreateChatInviteLink Methods parseJSON :: Value -> Parser CreateChatInviteLinkRequest # parseJSONList :: Value -> Parser [CreateChatInviteLinkRequest] #
ToJSON CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.CreateChatInviteLink Methods toJSON :: CreateChatInviteLinkRequest -> Value # toEncoding :: CreateChatInviteLinkRequest -> Encoding # toJSONList :: [CreateChatInviteLinkRequest] -> Value # toEncodingList :: [CreateChatInviteLinkRequest] -> Encoding #
Generic CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.CreateChatInviteLink Associated Types type Rep CreateChatInviteLinkRequest :: Type -> Type # Methods from :: CreateChatInviteLinkRequest -> Rep CreateChatInviteLinkRequest x # to :: Rep CreateChatInviteLinkRequest x -> CreateChatInviteLinkRequest #
type Rep CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.CreateChatInviteLink type Rep CreateChatInviteLinkRequest = D1 ('MetaData "CreateChatInviteLinkRequest" "Telegram.Bot.API.Methods.CreateChatInviteLink" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "CreateChatInviteLinkRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createChatInviteLinkChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "createChatInviteLinkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createChatInviteLinkExpireDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "createChatInviteLinkMemberLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "createChatInviteLinkCreatesJoinRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

type CreateChatInviteLink = "createChatInviteLink" :> (ReqBody '[JSON] CreateChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink)) Source #

createChatInviteLink :: CreateChatInviteLinkRequest -> ClientM (Response ChatInviteLink) Source #

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.