Package io.micronaut.chatbots.telegram.api

Class ChatInviteLink

java.lang.Object
io.micronaut.chatbots.telegram.api.ChatInviteLink
public class ChatInviteLink extends Object
Represents an invite link for a chat. ChatInviteLink
Since:
1.0.0
Author:
Sergio del Amo

  • Constructor Details

    • ChatInviteLink

      public ChatInviteLink()

  • Method Details

    • getInviteLink

      public String getInviteLink()
      Returns:
      The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "...";

    • setInviteLink

      public void setInviteLink(String inviteLink)
      Parameters:
      inviteLink - The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "...";

    • getCreator

      public User getCreator()
      Returns:
      Creator of the link.

    • setCreator

      public void setCreator(User creator)
      Parameters:
      creator - Creator of the link.

    • getCreatesJoinRequest

      public Boolean getCreatesJoinRequest()
      Returns:
      True, if users joining the chat via the link need to be approved by chat administrators.

    • setCreatesJoinRequest

      public void setCreatesJoinRequest(Boolean createsJoinRequest)
      Parameters:
      createsJoinRequest - True, if users joining the chat via the link need to be approved by chat administrators.

    • isPrimary

      public Boolean isPrimary()
      Returns:
      True, if the link is primary.

    • setPrimary

      public void setPrimary(Boolean primary)
      Parameters:
      primary - True, if the link is primary.

    • isRevoked

      public Boolean isRevoked()
      Returns:
      True, if the link is revoked.

    • setRevoked

      public void setRevoked(Boolean revoked)
      Parameters:
      revoked - True, if the link is revoked.

    • getName

      @Nullable public @Nullable String getName()
      Returns:
      Invite link name

    • setName

      public void setName(@Nullable @Nullable String name)
      Parameters:
      name - Invite link name

    • getExpireDate

      @Nullable public @Nullable Integer getExpireDate()
      Returns:
      Point in time (Unix timestamp) when the link will expire or has been expired.

    • setExpireDate

      public void setExpireDate(@Nullable @Nullable Integer expireDate)
      Parameters:
      expireDate - Point in time (Unix timestamp) when the link will expire or has been expired.

    • getMemberLimit

      @Nullable public @Nullable Integer getMemberLimit()
      Returns:
      The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

    • setMemberLimit

      public void setMemberLimit(@Nullable @Nullable Integer memberLimit)
      Parameters:
      memberLimit - The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

    • getPendingJoinRequestCount

      @Nullable public @Nullable Integer getPendingJoinRequestCount()
      Returns:
      Number of pending join requests created using this link.

    • setPendingJoinRequestCount

      public void setPendingJoinRequestCount(@Nullable @Nullable Integer pendingJoinRequestCount)
      Parameters:
      pendingJoinRequestCount - Number of pending join requests created using this link.