Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
8e35fe2fe5
Plan/all/com/djrapitops/plan/api/PlanAPI.html
Rsl1122 8e35fe2fe5 Updated javadocs
2019-08-09 10:23:33 +03:00

420 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc (1.8.0_201) on Fri Aug 09 10:21:39 EEST 2019 -->
<title>PlanAPI (Plan 4.9.2 API)</title>
<meta name="date" content="2019-08-09">
<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="PlanAPI (Plan 4.9.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":6,"i3":6,"i4":6,"i5":17,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated 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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/djrapitops/plan/api/CommonAPI.html" title="class in com.djrapitops.plan.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/api/PlanAPI.PlanAPIHolder.html" title="class in com.djrapitops.plan.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/api/PlanAPI.html" target="_top">Frames</a></li>
<li><a href="PlanAPI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">com.djrapitops.plan.api</div>
<h2 title="Interface PlanAPI" class="title">Interface PlanAPI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/djrapitops/plan/api/CommonAPI.html" title="class in com.djrapitops.plan.api">CommonAPI</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PlanAPI</span></pre>
<div class="block">Interface for PlanAPI methods.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.PlanAPIHolder.html" title="class in com.djrapitops.plan.api">PlanAPI.PlanAPIHolder</a></span></code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#addPluginDataSource-com.djrapitops.plan.data.plugin.PluginData-">addPluginDataSource</a></span>(<a href="../../../../com/djrapitops/plan/data/plugin/PluginData.html" title="class in com.djrapitops.plan.data.plugin">PluginData</a>&nbsp;pluginData)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/djrapitops/plan/system/database/databases/operation/FetchOperations.html" title="interface in com.djrapitops.plan.system.database.databases.operation">FetchOperations</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#fetchFromPlanDB--">fetchFromPlanDB</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">FetchOperations interface is going to removed since it is too rigid.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/djrapitops/plan/api/data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data">PlayerContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#fetchPlayerContainer-java.util.UUID-">fetchPlayerContainer</a></span>(java.util.UUID&nbsp;uuid)</code>
<div class="block">Fetch PlayerContainer from the database.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/djrapitops/plan/api/data/ServerContainer.html" title="class in com.djrapitops.plan.api.data">ServerContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#fetchServerContainer-java.util.UUID-">fetchServerContainer</a></span>(java.util.UUID&nbsp;serverUUID)</code>
<div class="block">Fetch a ServerContainer from the database.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;java.util.UUID&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#fetchServerUUIDs--">fetchServerUUIDs</a></span>()</code>
<div class="block">Fetch server UUIDs.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/djrapitops/plan/api/PlanAPI.html" title="interface in com.djrapitops.plan.api">PlanAPI</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.util.UUID,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#getKnownPlayerNames--">getKnownPlayerNames</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#getPlayerInspectPageLink-java.lang.String-">getPlayerInspectPageLink</a></span>(java.lang.String&nbsp;playerName)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#getPlayerInspectPageLink-java.util.UUID-">getPlayerInspectPageLink</a></span>(java.util.UUID&nbsp;uuid)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#getPlayerName-java.util.UUID-">getPlayerName</a></span>(java.util.UUID&nbsp;uuid)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.UUID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/api/PlanAPI.html#playerNameToUUID-java.lang.String-">playerNameToUUID</a></span>(java.lang.String&nbsp;playerName)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>static&nbsp;<a href="../../../../com/djrapitops/plan/api/PlanAPI.html" title="interface in com.djrapitops.plan.api">PlanAPI</a>&nbsp;getInstance()</pre>
</li>
</ul>
<a name="addPluginDataSource-com.djrapitops.plan.data.plugin.PluginData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPluginDataSource</h4>
<pre>@Deprecated
void&nbsp;addPluginDataSource(<a href="../../../../com/djrapitops/plan/data/plugin/PluginData.html" title="class in com.djrapitops.plan.data.plugin">PluginData</a>&nbsp;pluginData)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API.</span></div>
</li>
</ul>
<a name="getPlayerInspectPageLink-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerInspectPageLink</h4>
<pre>java.lang.String&nbsp;getPlayerInspectPageLink(java.util.UUID&nbsp;uuid)</pre>
</li>
</ul>
<a name="getPlayerInspectPageLink-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerInspectPageLink</h4>
<pre>java.lang.String&nbsp;getPlayerInspectPageLink(java.lang.String&nbsp;playerName)</pre>
</li>
</ul>
<a name="getPlayerName-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerName</h4>
<pre>java.lang.String&nbsp;getPlayerName(java.util.UUID&nbsp;uuid)</pre>
</li>
</ul>
<a name="playerNameToUUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>playerNameToUUID</h4>
<pre>java.util.UUID&nbsp;playerNameToUUID(java.lang.String&nbsp;playerName)</pre>
</li>
</ul>
<a name="getKnownPlayerNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKnownPlayerNames</h4>
<pre>java.util.Map&lt;java.util.UUID,java.lang.String&gt;&nbsp;getKnownPlayerNames()</pre>
</li>
</ul>
<a name="fetchFromPlanDB--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchFromPlanDB</h4>
<pre>@Deprecated
<a href="../../../../com/djrapitops/plan/system/database/databases/operation/FetchOperations.html" title="interface in com.djrapitops.plan.system.database.databases.operation">FetchOperations</a>&nbsp;fetchFromPlanDB()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">FetchOperations interface is going to removed since it is too rigid.</span></div>
<div class="block">Fetch things from the database.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FetchOperations object.</dd>
</dl>
</li>
</ul>
<a name="fetchPlayerContainer-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchPlayerContainer</h4>
<pre><a href="../../../../com/djrapitops/plan/api/data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data">PlayerContainer</a>&nbsp;fetchPlayerContainer(java.util.UUID&nbsp;uuid)</pre>
<div class="block">Fetch PlayerContainer from the database.
<p>
Blocking operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the player.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../com/djrapitops/plan/api/data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data"><code>PlayerContainer</code></a>.</dd>
</dl>
</li>
</ul>
<a name="fetchServerContainer-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchServerContainer</h4>
<pre><a href="../../../../com/djrapitops/plan/api/data/ServerContainer.html" title="class in com.djrapitops.plan.api.data">ServerContainer</a>&nbsp;fetchServerContainer(java.util.UUID&nbsp;serverUUID)</pre>
<div class="block">Fetch a ServerContainer from the database.
<p>
Blocking operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serverUUID</code> - UUID of the server.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../com/djrapitops/plan/api/data/ServerContainer.html" title="class in com.djrapitops.plan.api.data"><code>ServerContainer</code></a>.</dd>
</dl>
</li>
</ul>
<a name="fetchServerUUIDs--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fetchServerUUIDs</h4>
<pre>java.util.Collection&lt;java.util.UUID&gt;&nbsp;fetchServerUUIDs()</pre>
<div class="block">Fetch server UUIDs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>All Plan server UUIDs.</dd>
</dl>
</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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/djrapitops/plan/api/CommonAPI.html" title="class in com.djrapitops.plan.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/api/PlanAPI.PlanAPIHolder.html" title="class in com.djrapitops.plan.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/api/PlanAPI.html" target="_top">Frames</a></li>
<li><a href="PlanAPI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink