Class TdApi.CreateChatInviteLink

  • Enclosing class:
    TdApi

    public static class TdApi.CreateChatInviteLink
    extends TdApi.Function
    Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and canInviteUsers right in the chat.

    Returns ChatInviteLink

    • Field Detail

      • chatId

        public long chatId
        Chat identifier.
      • name

        public String name
        Invite link name; 0-32 characters.
      • expirationDate

        public int expirationDate
        Point in time (Unix timestamp) when the link will expire; pass 0 if never.
      • memberLimit

        public int memberLimit
        The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.
      • createsJoinRequest

        public boolean createsJoinRequest
        True, if the link only creates join request. If true, memberLimit must not be specified.
      • CONSTRUCTOR

        public static final int CONSTRUCTOR
        Identifier uniquely determining type of the object.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CreateChatInviteLink

        public CreateChatInviteLink()
        Default constructor for a function, which creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and canInviteUsers right in the chat.

        Returns ChatInviteLink

      • CreateChatInviteLink

        public CreateChatInviteLink​(long chatId,
                                    String name,
                                    int expirationDate,
                                    int memberLimit,
                                    boolean createsJoinRequest)
        Creates a function, which creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and canInviteUsers right in the chat.

        Returns ChatInviteLink

        Parameters:
        chatId - Chat identifier.
        name - Invite link name; 0-32 characters.
        expirationDate - Point in time (Unix timestamp) when the link will expire; pass 0 if never.
        memberLimit - The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.
        createsJoinRequest - True, if the link only creates join request. If true, memberLimit must not be specified.