Package io.micronaut.chatbots.telegram.api

Class ChatInviteLink

  • public class ChatInviteLink
extends java.lang.Object
    Represents an invite link for a chat. ChatInviteLink
    Since:
    1.0.0
    Author:
    Sergio del Amo

    • Constructor Detail

      • ChatInviteLink

        public ChatInviteLink()

    • Method Detail

      • getInviteLink

        public java.lang.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​(java.lang.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 java.lang.Boolean getCreatesJoinRequest()
        Returns:
        True, if users joining the chat via the link need to be approved by chat administrators.

      • setCreatesJoinRequest

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

      • isPrimary

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

      • setPrimary

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

      • isRevoked

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

      • setRevoked

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

      • getName

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

      • setName

        public void setName​(@Nullable
                    java.lang.String name)
        Parameters:
        name - Invite link name

      • getExpireDate

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

      • setExpireDate

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

      • getMemberLimit

        @Nullable
public java.lang.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
                           java.lang.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 java.lang.Integer getPendingJoinRequestCount()
        Returns:
        Number of pending join requests created using this link.

      • setPendingJoinRequestCount

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