Module tdlight.api

Class TdApi.CreateChatInviteLink

Enclosing class:
TdApi

public static final class TdApi.CreateChatInviteLink extends TdApi.Function<TdApi.ChatInviteLink>
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 Details

    • 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
      Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, memberLimit must be 0.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      See Also:
  • Constructor Details

    • CreateChatInviteLink

      public CreateChatInviteLink()
      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 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 - long Chat identifier.
      name - String Invite link name; 0-32 characters.
      expirationDate - int Point in time (Unix timestamp) when the link will expire; pass 0 if never.
      memberLimit - int The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.
      createsJoinRequest - boolean Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, memberLimit must be 0.
    • CreateChatInviteLink

      public CreateChatInviteLink(DataInput input) throws IOException
      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
      Throws:
      IOException
  • Method Details