Class TdApi.Supergroup

java.lang.Object
org.drinkless.tdlib.TdApi.Object
org.drinkless.tdlib.TdApi.Supergroup
Enclosing class:
TdApi

public static class TdApi.Supergroup extends TdApi.Object
Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    Approximate boost level for the chat.
    static final int
    Identifier uniquely determining type of the object.
    int
    Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member.
    boolean
    True, if the supergroup or channel has non-expired stories available to the current user.
    boolean
    True, if automatic translation of messages is enabled in the channel.
    boolean
    True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.
    boolean
    True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.
    boolean
    True, if content of media messages in the supergroup or channel chat must be hidden with 18+ spoiler.
    boolean
    True, if the supergroup or channel has unread non-expired stories available to the current user.
    long
    Supergroup or channel identifier.
    boolean
    True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members.
    boolean
    True, if the supergroup is a channel.
    boolean
    True, if the supergroup is a forum with topics.
    boolean
    True, if the slow mode is enabled in the supergroup.
    boolean
    True, if all users directly joining the supergroup need to be approved by supergroup administrators.
    boolean
    True, if users need to join the supergroup before they can send messages.
    int
    Number of members in the supergroup or channel; 0 if unknown.
    long
    Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message.
    If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted.
    boolean
    True, if messages sent to the channel have information about the sender user.
    boolean
    True, if messages sent to the channel contains name of the sender.
    Status of the current user in the supergroup or channel; custom title will always be empty.
    Usernames of the supergroup or channel; may be null.
    Information about verification status of the supergroup or channel; may be null if none.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Represents a supergroup or channel with zero or more members (subscribers in the case of channels).
    Supergroup(long id, TdApi.Usernames usernames, int date, TdApi.ChatMemberStatus status, int memberCount, int boostLevel, boolean hasAutomaticTranslation, boolean hasLinkedChat, boolean hasLocation, boolean signMessages, boolean showMessageSender, boolean joinToSendMessages, boolean joinByRequest, boolean isSlowModeEnabled, boolean isChannel, boolean isBroadcastGroup, boolean isForum, TdApi.VerificationStatus verificationStatus, boolean hasSensitiveContent, String restrictionReason, long paidMessageStarCount, boolean hasActiveStories, boolean hasUnreadActiveStories)
    Represents a supergroup or channel with zero or more members (subscribers in the case of channels).
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns an identifier uniquely determining type of the object.

    Methods inherited from class org.drinkless.tdlib.TdApi.Object

    toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • id

      public long id
      Supergroup or channel identifier.
    • usernames

      public TdApi.Usernames usernames
      Usernames of the supergroup or channel; may be null.
    • date

      public int date
      Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member.
    • status

      public TdApi.ChatMemberStatus status
      Status of the current user in the supergroup or channel; custom title will always be empty.
    • memberCount

      public int memberCount
      Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through getChatSimilarChats, getChatsToPostStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchPublicChats, or in chatFolderInviteLinkInfo.missingChatIds, or in userFullInfo.personalChatId, or for chats with messages or stories from publicForwards and foundStories.
    • boostLevel

      public int boostLevel
      Approximate boost level for the chat.
    • hasAutomaticTranslation

      public boolean hasAutomaticTranslation
      True, if automatic translation of messages is enabled in the channel.
    • hasLinkedChat

      public boolean hasLinkedChat
      True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.
    • hasLocation

      public boolean hasLocation
      True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.
    • signMessages

      public boolean signMessages
      True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.
    • showMessageSender

      public boolean showMessageSender
      True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.
    • joinToSendMessages

      public boolean joinToSendMessages
      True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups.
    • joinByRequest

      public boolean joinByRequest
      True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat.
    • isSlowModeEnabled

      public boolean isSlowModeEnabled
      True, if the slow mode is enabled in the supergroup.
    • isChannel

      public boolean isChannel
      True, if the supergroup is a channel.
    • isBroadcastGroup

      public boolean isBroadcastGroup
      True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members.
    • isForum

      public boolean isForum
      True, if the supergroup is a forum with topics.
    • verificationStatus

      public TdApi.VerificationStatus verificationStatus
      Information about verification status of the supergroup or channel; may be null if none.
    • hasSensitiveContent

      public boolean hasSensitiveContent
      True, if content of media messages in the supergroup or channel chat must be hidden with 18+ spoiler.
    • restrictionReason

      public String restrictionReason
      If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted.
    • paidMessageStarCount

      public long paidMessageStarCount
      Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message.
    • hasActiveStories

      public boolean hasActiveStories
      True, if the supergroup or channel has non-expired stories available to the current user.
    • hasUnreadActiveStories

      public boolean hasUnreadActiveStories
      True, if the supergroup or channel has unread non-expired stories available to the current user.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      See Also:
  • Constructor Details

    • Supergroup

      public Supergroup()
      Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers.
    • Supergroup

      public Supergroup(long id, TdApi.Usernames usernames, int date, TdApi.ChatMemberStatus status, int memberCount, int boostLevel, boolean hasAutomaticTranslation, boolean hasLinkedChat, boolean hasLocation, boolean signMessages, boolean showMessageSender, boolean joinToSendMessages, boolean joinByRequest, boolean isSlowModeEnabled, boolean isChannel, boolean isBroadcastGroup, boolean isForum, TdApi.VerificationStatus verificationStatus, boolean hasSensitiveContent, String restrictionReason, long paidMessageStarCount, boolean hasActiveStories, boolean hasUnreadActiveStories)
      Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers.
      Parameters:
      id - Supergroup or channel identifier.
      usernames - Usernames of the supergroup or channel; may be null.
      date - Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member.
      status - Status of the current user in the supergroup or channel; custom title will always be empty.
      memberCount - Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through getChatSimilarChats, getChatsToPostStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchPublicChats, or in chatFolderInviteLinkInfo.missingChatIds, or in userFullInfo.personalChatId, or for chats with messages or stories from publicForwards and foundStories.
      boostLevel - Approximate boost level for the chat.
      hasAutomaticTranslation - True, if automatic translation of messages is enabled in the channel.
      hasLinkedChat - True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.
      hasLocation - True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.
      signMessages - True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.
      showMessageSender - True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.
      joinToSendMessages - True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups.
      joinByRequest - True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat.
      isSlowModeEnabled - True, if the slow mode is enabled in the supergroup.
      isChannel - True, if the supergroup is a channel.
      isBroadcastGroup - True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members.
      isForum - True, if the supergroup is a forum with topics.
      verificationStatus - Information about verification status of the supergroup or channel; may be null if none.
      hasSensitiveContent - True, if content of media messages in the supergroup or channel chat must be hidden with 18+ spoiler.
      restrictionReason - If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted.
      paidMessageStarCount - Number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message.
      hasActiveStories - True, if the supergroup or channel has non-expired stories available to the current user.
      hasUnreadActiveStories - True, if the supergroup or channel has unread non-expired stories available to the current user.
  • Method Details

    • getConstructor

      public int getConstructor()
      Description copied from class: TdApi.Object
      Returns an identifier uniquely determining type of the object.
      Specified by:
      getConstructor in class TdApi.Object
      Returns:
      this.CONSTRUCTOR