tdlight-team/tdlight-docs
1
1
Fork 0
Code Releases Activity
58c5bcf727
tdlight-docs/tdlight.api/it/tdlight/jni/TdApi.Supergroup.html
Andrea Cavalli 58c5bcf727 Update javadocs
2022-11-12 12:07:31 +00:00

706 lines
39 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TdApi.Supergroup (tdlight API 4.0.275 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"><style>
#memberSummary_tabpanel{overflow-x: auto;}
li.blockList{overflow-x: auto;}
td.colLast div{max-width:30vw;}
#search{width: 400px;max-width: 65vw;}
.title,.subTitle,pre,.inheritance,h1,h2,h3,h4,h5,.memberSummary,.memberSignature,.typeSummary,.blockList,.contentContainer{white-space:normal;word-break:break-word;}
ul{padding-left:10px}
</style>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: tdlight.api, package: it.tdlight.jni, class: TdApi, class: Supergroup">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/TdApi.Supergroup.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../module-summary.html">tdlight.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">it.tdlight.jni</a></div>
<h1 title="Class TdApi.Supergroup" class="title">Class TdApi.Supergroup</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="TdApi.Object.html" title="class in it.tdlight.jni">it.tdlight.jni.TdApi.Object</a>
<div class="inheritance">it.tdlight.jni.TdApi.Supergroup</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="TdApi.html" title="class in it.tdlight.jni">TdApi</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">TdApi.Supergroup</span>
<span class="extends-implements">extends <a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></span></div>
<div class="block">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.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#CONSTRUCTOR" class="member-name-link">CONSTRUCTOR</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>int</code></div>
<div class="col-second odd-row-color"><code><a href="#date" class="member-name-link">date</a></code></div>
<div class="col-last odd-row-color">
<div class="block">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.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#hasLinkedChat" class="member-name-link">hasLinkedChat</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if the channel has a discussion
group, or the supergroup is the
designated discussion group for a channel.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#hasLocation" class="member-name-link">hasLocation</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if the supergroup is connected
to a location, i.e.</div>
</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><code><a href="#id" class="member-name-link">id</a></code></div>
<div class="col-last even-row-color">
<div class="block">Supergroup or channel identifier.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#isBroadcastGroup" class="member-name-link">isBroadcastGroup</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if the supergroup is a broadcast
group, i.e.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#isChannel" class="member-name-link">isChannel</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if the supergroup is a channel.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#isFake" class="member-name-link">isFake</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if many users reported this
supergroup or channel as a fake account.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#isForum" class="member-name-link">isForum</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if the supergroup must be shown
as a forum by default.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#isScam" class="member-name-link">isScam</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if many users reported this
supergroup or channel as a scam.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#isSlowModeEnabled" class="member-name-link">isSlowModeEnabled</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if the slow mode is enabled in the supergroup.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#isVerified" class="member-name-link">isVerified</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if the supergroup or channel is verified.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#joinByRequest" class="member-name-link">joinByRequest</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if all users directly joining
the supergroup need to be approved by
supergroup administrators.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#joinToSendMessages" class="member-name-link">joinToSendMessages</a></code></div>
<div class="col-last odd-row-color">
<div class="block">True, if users need to join the
supergroup before they can send
messages.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#memberCount" class="member-name-link">memberCount</a></code></div>
<div class="col-last even-row-color">
<div class="block">Number of members in the supergroup
or channel; 0 if unknown.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#restrictionReason" class="member-name-link">restrictionReason</a></code></div>
<div class="col-last odd-row-color">
<div class="block">If non-empty, contains a human-readable
description of the reason why access
to this supergroup or channel must be restricted.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#signMessages" class="member-name-link">signMessages</a></code></div>
<div class="col-last even-row-color">
<div class="block">True, if messages sent to the channel
need to contain information about the
sender.</div>
</div>
<div class="col-first odd-row-color"><code><a href="TdApi.ChatMemberStatus.html" title="class in it.tdlight.jni">TdApi.ChatMemberStatus</a></code></div>
<div class="col-second odd-row-color"><code><a href="#status" class="member-name-link">status</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Status of the current user in the
supergroup or channel; custom title
will always be empty.</div>
</div>
<div class="col-first even-row-color"><code><a href="TdApi.Usernames.html" title="class in it.tdlight.jni">TdApi.Usernames</a></code></div>
<div class="col-second even-row-color"><code><a href="#usernames" class="member-name-link">usernames</a></code></div>
<div class="col-last even-row-color">
<div class="block">Usernames of the supergroup or channel;
may be null.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Supergroup</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Represents a supergroup or channel
with zero or more members (subscribers
in the case of channels).</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long,it.tdlight.jni.TdApi.Usernames,int,it.tdlight.jni.TdApi.ChatMemberStatus,int,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,java.lang.String,boolean,boolean)" class="member-name-link">Supergroup</a><wbr>(long&nbsp;id,
<a href="TdApi.Usernames.html" title="class in it.tdlight.jni">TdApi.Usernames</a>&nbsp;usernames,
int&nbsp;date,
<a href="TdApi.ChatMemberStatus.html" title="class in it.tdlight.jni">TdApi.ChatMemberStatus</a>&nbsp;status,
int&nbsp;memberCount,
boolean&nbsp;hasLinkedChat,
boolean&nbsp;hasLocation,
boolean&nbsp;signMessages,
boolean&nbsp;joinToSendMessages,
boolean&nbsp;joinByRequest,
boolean&nbsp;isSlowModeEnabled,
boolean&nbsp;isChannel,
boolean&nbsp;isBroadcastGroup,
boolean&nbsp;isForum,
boolean&nbsp;isVerified,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;restrictionReason,
boolean&nbsp;isScam,
boolean&nbsp;isFake)</code></div>
<div class="col-last odd-row-color">
<div class="block">Represents a supergroup or channel
with zero or more members (subscribers
in the case of channels).</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.DataInput)" class="member-name-link">Supergroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a>&nbsp;input)</code></div>
<div class="col-last even-row-color">
<div class="block">Represents a supergroup or channel
with zero or more members (subscribers
in the case of channels).</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConstructor()" class="member-name-link">getConstructor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serialize(java.io.DataOutput)" class="member-name-link">serialize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a>&nbsp;output)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-it.tdlight.jni.TdApi.Object">Methods inherited from class&nbsp;it.tdlight.jni.<a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></h3>
<code><a href="TdApi.Object.html#serialize()">serialize</a>, <a href="TdApi.Object.html#toString()">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="id">
<h3>id</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">id</span></div>
<div class="block">Supergroup or channel identifier.</div>
</section>
</li>
<li>
<section class="detail" id="usernames">
<h3>usernames</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TdApi.Usernames.html" title="class in it.tdlight.jni">TdApi.Usernames</a></span>&nbsp;<span class="element-name">usernames</span></div>
<div class="block">Usernames of the supergroup or channel;
may be null.</div>
</section>
</li>
<li>
<section class="detail" id="date">
<h3>date</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">date</span></div>
<div class="block">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.</div>
</section>
</li>
<li>
<section class="detail" id="status">
<h3>status</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TdApi.ChatMemberStatus.html" title="class in it.tdlight.jni">TdApi.ChatMemberStatus</a></span>&nbsp;<span class="element-name">status</span></div>
<div class="block">Status of the current user in the
supergroup or channel; custom title
will always be empty.</div>
</section>
</li>
<li>
<section class="detail" id="memberCount">
<h3>memberCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">memberCount</span></div>
<div class="block">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 searchPublicChats, searchChatsNearby,
getInactiveSupergroupChats,
getSuitableDiscussionChats,
getGroupsInCommon, or getUserPrivacySettingRules.</div>
</section>
</li>
<li>
<section class="detail" id="hasLinkedChat">
<h3>hasLinkedChat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasLinkedChat</span></div>
<div class="block">True, if the channel has a discussion
group, or the supergroup is the
designated discussion group for a channel.</div>
</section>
</li>
<li>
<section class="detail" id="hasLocation">
<h3>hasLocation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasLocation</span></div>
<div class="block">True, if the supergroup is connected
to a location, i.e. the supergroup is
a location-based supergroup.</div>
</section>
</li>
<li>
<section class="detail" id="signMessages">
<h3>signMessages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">signMessages</span></div>
<div class="block">True, if messages sent to the channel
need to contain information about the
sender. This field is only applicable to channels.</div>
</section>
</li>
<li>
<section class="detail" id="joinToSendMessages">
<h3>joinToSendMessages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">joinToSendMessages</span></div>
<div class="block">True, if users need to join the
supergroup before they can send
messages. Always true for channels
and non-discussion supergroups.</div>
</section>
</li>
<li>
<section class="detail" id="joinByRequest">
<h3>joinByRequest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">joinByRequest</span></div>
<div class="block">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.</div>
</section>
</li>
<li>
<section class="detail" id="isSlowModeEnabled">
<h3>isSlowModeEnabled</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSlowModeEnabled</span></div>
<div class="block">True, if the slow mode is enabled in the supergroup.</div>
</section>
</li>
<li>
<section class="detail" id="isChannel">
<h3>isChannel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isChannel</span></div>
<div class="block">True, if the supergroup is a channel.</div>
</section>
</li>
<li>
<section class="detail" id="isBroadcastGroup">
<h3>isBroadcastGroup</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isBroadcastGroup</span></div>
<div class="block">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.</div>
</section>
</li>
<li>
<section class="detail" id="isForum">
<h3>isForum</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isForum</span></div>
<div class="block">True, if the supergroup must be shown
as a forum by default.</div>
</section>
</li>
<li>
<section class="detail" id="isVerified">
<h3>isVerified</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isVerified</span></div>
<div class="block">True, if the supergroup or channel is verified.</div>
</section>
</li>
<li>
<section class="detail" id="restrictionReason">
<h3>restrictionReason</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">restrictionReason</span></div>
<div class="block">If non-empty, contains a human-readable
description of the reason why access
to this supergroup or channel must be restricted.</div>
</section>
</li>
<li>
<section class="detail" id="isScam">
<h3>isScam</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isScam</span></div>
<div class="block">True, if many users reported this
supergroup or channel as a scam.</div>
</section>
</li>
<li>
<section class="detail" id="isFake">
<h3>isFake</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isFake</span></div>
<div class="block">True, if many users reported this
supergroup or channel as a fake account.</div>
</section>
</li>
<li>
<section class="detail" id="CONSTRUCTOR">
<h3>CONSTRUCTOR</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">CONSTRUCTOR</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#it.tdlight.jni.TdApi.Supergroup.CONSTRUCTOR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Supergroup</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Supergroup</span>()</div>
<div class="block">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.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(long,it.tdlight.jni.TdApi.Usernames,int,it.tdlight.jni.TdApi.ChatMemberStatus,int,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,java.lang.String,boolean,boolean)">
<h3>Supergroup</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Supergroup</span><wbr><span class="parameters">(long&nbsp;id,
<a href="TdApi.Usernames.html" title="class in it.tdlight.jni">TdApi.Usernames</a>&nbsp;usernames,
int&nbsp;date,
<a href="TdApi.ChatMemberStatus.html" title="class in it.tdlight.jni">TdApi.ChatMemberStatus</a>&nbsp;status,
int&nbsp;memberCount,
boolean&nbsp;hasLinkedChat,
boolean&nbsp;hasLocation,
boolean&nbsp;signMessages,
boolean&nbsp;joinToSendMessages,
boolean&nbsp;joinByRequest,
boolean&nbsp;isSlowModeEnabled,
boolean&nbsp;isChannel,
boolean&nbsp;isBroadcastGroup,
boolean&nbsp;isForum,
boolean&nbsp;isVerified,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;restrictionReason,
boolean&nbsp;isScam,
boolean&nbsp;isFake)</span></div>
<div class="block">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.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - long Supergroup or channel identifier.</dd>
<dd><code>usernames</code> - Usernames Usernames of the supergroup or channel;
may be null.</dd>
<dd><code>date</code> - 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.</dd>
<dd><code>status</code> - ChatMemberStatus Status of the current user in the
supergroup or channel; custom title
will always be empty.</dd>
<dd><code>memberCount</code> - int 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 searchPublicChats, searchChatsNearby,
getInactiveSupergroupChats,
getSuitableDiscussionChats,
getGroupsInCommon, or getUserPrivacySettingRules.</dd>
<dd><code>hasLinkedChat</code> - boolean True, if the channel has a discussion
group, or the supergroup is the
designated discussion group for a channel.</dd>
<dd><code>hasLocation</code> - boolean True, if the supergroup is connected
to a location, i.e. the supergroup is
a location-based supergroup.</dd>
<dd><code>signMessages</code> - boolean True, if messages sent to the channel
need to contain information about the
sender. This field is only applicable to channels.</dd>
<dd><code>joinToSendMessages</code> - boolean True, if users need to join the
supergroup before they can send
messages. Always true for channels
and non-discussion supergroups.</dd>
<dd><code>joinByRequest</code> - boolean 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.</dd>
<dd><code>isSlowModeEnabled</code> - boolean True, if the slow mode is enabled in the supergroup.</dd>
<dd><code>isChannel</code> - boolean True, if the supergroup is a channel.</dd>
<dd><code>isBroadcastGroup</code> - 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.</dd>
<dd><code>isForum</code> - boolean True, if the supergroup must be shown
as a forum by default.</dd>
<dd><code>isVerified</code> - boolean True, if the supergroup or channel is verified.</dd>
<dd><code>restrictionReason</code> - String If non-empty, contains a human-readable
description of the reason why access
to this supergroup or channel must be restricted.</dd>
<dd><code>isScam</code> - boolean True, if many users reported this
supergroup or channel as a scam.</dd>
<dd><code>isFake</code> - boolean True, if many users reported this
supergroup or channel as a fake account.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.io.DataInput)">
<h3>Supergroup</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Supergroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a>&nbsp;input)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">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.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getConstructor()">
<h3>getConstructor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getConstructor</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="TdApi.Object.html#getConstructor()">getConstructor</a></code>&nbsp;in class&nbsp;<code><a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="serialize(java.io.DataOutput)">
<h3>serialize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">serialize</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a>&nbsp;output)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="TdApi.Object.html#serialize(java.io.DataOutput)">serialize</a></code>&nbsp;in class&nbsp;<code><a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2022. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink