<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>PlanAPI (Plan 5.2-SNAPSHOT API)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> <!--[if IE]> <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> <![endif]--> <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="PlanAPI (Plan 5.2-SNAPSHOT API)"; } } catch(err) { } //--> var data = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":33,"i5":38,"i6":38,"i7":38,"i8":38,"i9":38}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../../"; var useModuleDirectories = true; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.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" id="allclasses_navbar_top"> <li><a href="../../../../allclasses.html">All Classes</a></li> </ul> <ul class="navListSearch"> <li><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </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> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.api</a></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><code><a href="CommonAPI.html" title="class in com.djrapitops.plan.api">CommonAPI</a></code></dd> </dl> <hr> <pre>@Deprecated public interface <span class="typeNameLabel">PlanAPI</span></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Plan API v4 has been deprecated, use the APIv5 instead (https://github.com/plan-player-analytics/Plan/wiki/APIv5).</div> </div> <div class="block">Interface for PlanAPI methods.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="memberSummary"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Interface</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PlanAPI.PlanAPIHolder.html" title="class in com.djrapitops.plan.api">PlanAPI.PlanAPIHolder</a></span></code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> </table> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPluginDataSource(com.djrapitops.plan.data.plugin.PluginData)">addPluginDataSource</a></span>​(<a href="../data/plugin/PluginData.html" title="class in com.djrapitops.plan.data.plugin">PluginData</a> pluginData)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API.</div> </div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data">PlayerContainer</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchPlayerContainer(java.util.UUID)">fetchPlayerContainer</a></span>​(java.util.UUID uuid)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Fetch PlayerContainer from the database.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="data/ServerContainer.html" title="class in com.djrapitops.plan.api.data">ServerContainer</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchServerContainer(java.util.UUID)">fetchServerContainer</a></span>​(java.util.UUID serverUUID)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Fetch a ServerContainer from the database.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.util.Collection<java.util.UUID></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchServerUUIDs()">fetchServerUUIDs</a></span>()</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Fetch server UUIDs.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>static <a href="PlanAPI.html" title="interface in com.djrapitops.plan.api">PlanAPI</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.util.Map<java.util.UUID,​java.lang.String></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKnownPlayerNames()">getKnownPlayerNames</a></span>()</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlayerInspectPageLink(java.lang.String)">getPlayerInspectPageLink</a></span>​(java.lang.String playerName)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlayerInspectPageLink(java.util.UUID)">getPlayerInspectPageLink</a></span>​(java.util.UUID uuid)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlayerName(java.util.UUID)">getPlayerName</a></span>​(java.util.UUID uuid)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>java.util.UUID</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#playerNameToUUID(java.lang.String)">playerNameToUUID</a></span>​(java.lang.String playerName)</code></th> <td class="colLast"> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </td> </tr> </table> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="getInstance()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInstance</h4> <pre class="methodSignature">static <a href="PlanAPI.html" title="interface in com.djrapitops.plan.api">PlanAPI</a> getInstance()</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="addPluginDataSource(com.djrapitops.plan.data.plugin.PluginData)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addPluginDataSource</h4> <pre class="methodSignature">@Deprecated void addPluginDataSource​(<a href="../data/plugin/PluginData.html" title="class in com.djrapitops.plan.data.plugin">PluginData</a> pluginData)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API.</div> </div> </li> </ul> <a id="getPlayerInspectPageLink(java.util.UUID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlayerInspectPageLink</h4> <pre class="methodSignature">java.lang.String getPlayerInspectPageLink​(java.util.UUID uuid)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="getPlayerInspectPageLink(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlayerInspectPageLink</h4> <pre class="methodSignature">java.lang.String getPlayerInspectPageLink​(java.lang.String playerName)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="getPlayerName(java.util.UUID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlayerName</h4> <pre class="methodSignature">java.lang.String getPlayerName​(java.util.UUID uuid)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="playerNameToUUID(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>playerNameToUUID</h4> <pre class="methodSignature">java.util.UUID playerNameToUUID​(java.lang.String playerName)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="getKnownPlayerNames()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getKnownPlayerNames</h4> <pre class="methodSignature">java.util.Map<java.util.UUID,​java.lang.String> getKnownPlayerNames()</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> </li> </ul> <a id="fetchPlayerContainer(java.util.UUID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fetchPlayerContainer</h4> <pre class="methodSignature"><a href="data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data">PlayerContainer</a> fetchPlayerContainer​(java.util.UUID uuid)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> <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="data/PlayerContainer.html" title="class in com.djrapitops.plan.api.data"><code>PlayerContainer</code></a>.</dd> </dl> </li> </ul> <a id="fetchServerContainer(java.util.UUID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fetchServerContainer</h4> <pre class="methodSignature"><a href="data/ServerContainer.html" title="class in com.djrapitops.plan.api.data">ServerContainer</a> fetchServerContainer​(java.util.UUID serverUUID)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> <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="data/ServerContainer.html" title="class in com.djrapitops.plan.api.data"><code>ServerContainer</code></a>.</dd> </dl> </li> </ul> <a id="fetchServerUUIDs()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>fetchServerUUIDs</h4> <pre class="methodSignature">java.util.Collection<java.util.UUID> fetchServerUUIDs()</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> <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> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses.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> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>