mirror of
https://github.com/ryandw11/UltraChat.git
synced 2024-12-13 04:26:46 +01:00
438 lines
17 KiB
HTML
438 lines
17 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_112) on Fri Jun 26 19:55:13 MST 2020 -->
|
|
<title>ChannelBuilder</title>
|
|
<meta name="date" content="2020-06-26">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="ChannelBuilder";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev Class</li>
|
|
<li><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChatChannel.html" title="class in me.ryandw11.ultrachat.api.channels"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" target="_top">Frames</a></li>
|
|
<li><a href="ChannelBuilder.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">me.ryandw11.ultrachat.api.channels</div>
|
|
<h2 title="Class ChannelBuilder" class="title">Class ChannelBuilder</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>me.ryandw11.ultrachat.api.channels.ChannelBuilder</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">ChannelBuilder</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A Builder to make a channel.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>2.3.3</dd>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Ryandw11</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#ChannelBuilder-java.lang.String-">ChannelBuilder</a></span>(java.lang.String name)</code>
|
|
<div class="block">The Builder to create a channel.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChatChannel.html" title="class in me.ryandw11.ultrachat.api.channels">ChatChannel</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#build--">build</a></span>()</code>
|
|
<div class="block">Build the channel</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#getFormat--">getFormat</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.util.List<java.lang.String></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#getJson--">getJson</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setAlwaysAppear-boolean-">setAlwaysAppear</a></span>(boolean alwaysAppear)</code>
|
|
<div class="block">Set if the channel is always appear</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setFormat-java.lang.String-">setFormat</a></span>(java.lang.String format)</code> </td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setJson-java.util.List-">setJson</a></span>(java.util.List<java.lang.String> json)</code>
|
|
<div class="block">Set the json lore.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code>
|
|
<div class="block">Set the name of the channel.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setPermission-java.lang.String-">setPermission</a></span>(java.lang.String permission)</code>
|
|
<div class="block">Set the permission for the channel.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html#setPrefix-java.lang.String-">setPrefix</a></span>(java.lang.String prefix)</code>
|
|
<div class="block">Set the prefix of the channel</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="ChannelBuilder-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ChannelBuilder</h4>
|
|
<pre>public ChannelBuilder(java.lang.String name)</pre>
|
|
<div class="block">The Builder to create a channel.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The name of the channel (usually lowercase)</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="setName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setName</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setName(java.lang.String name)</pre>
|
|
<div class="block">Set the name of the channel.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - The name. (Lowercase is standard)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPrefix-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPrefix</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setPrefix(java.lang.String prefix)</pre>
|
|
<div class="block">Set the prefix of the channel</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>prefix</code> - The prefix (supports & codes)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPermission-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPermission</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setPermission(java.lang.String permission)</pre>
|
|
<div class="block">Set the permission for the channel.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>permission</code> - The permission</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setAlwaysAppear-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAlwaysAppear</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setAlwaysAppear(boolean alwaysAppear)</pre>
|
|
<div class="block">Set if the channel is always appear</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>alwaysAppear</code> - If the channel should always appear.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The builder</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="build--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>build</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChatChannel.html" title="class in me.ryandw11.ultrachat.api.channels">ChatChannel</a> build()</pre>
|
|
<div class="block">Build the channel</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The channel. Note: If the channel name is already used it will return the existing one.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getJson--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getJson</h4>
|
|
<pre>public java.util.List<java.lang.String> getJson()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="setJson-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setJson</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setJson(java.util.List<java.lang.String> json)</pre>
|
|
<div class="block">Set the json lore.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>json</code> - List of lore.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFormat--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFormat</h4>
|
|
<pre>public java.lang.String getFormat()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="setFormat-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>setFormat</h4>
|
|
<pre>public <a href="../../../../../me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" title="class in me.ryandw11.ultrachat.api.channels">ChannelBuilder</a> setFormat(java.lang.String format)</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev Class</li>
|
|
<li><a href="../../../../../me/ryandw11/ultrachat/api/channels/ChatChannel.html" title="class in me.ryandw11.ultrachat.api.channels"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?me/ryandw11/ultrachat/api/channels/ChannelBuilder.html" target="_top">Frames</a></li>
|
|
<li><a href="ChannelBuilder.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|