mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 00:39:34 +01:00
359 lines
13 KiB
HTML
359 lines
13 KiB
HTML
<!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 -->
|
|
<title>CommonQueries (api 5.1-SNAPSHOT API)</title>
|
|
<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="CommonQueries (api 5.1-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev Class</li>
|
|
<li><a href="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/djrapitops/plan/query/CommonQueries.html" target="_top">Frames</a></li>
|
|
<li><a href="CommonQueries.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>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 name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">com.djrapitops.plan.query</div>
|
|
<h2 title="Interface CommonQueries" class="title">Interface CommonQueries</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">CommonQueries</span></pre>
|
|
<div class="block">Class that allows performing most commonly wanted queries.
|
|
<p>
|
|
This exists so that SQL does not necessarily need to be written.
|
|
Obtain an instance from <a href="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><code>QueryService</code></a>.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#doesDBHaveTable-java.lang.String-">doesDBHaveTable</a></span>(java.lang.String table)</code> </td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#doesDBHaveTableColumn-java.lang.String-java.lang.String-">doesDBHaveTableColumn</a></span>(java.lang.String table,
|
|
java.lang.String column)</code> </td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchCurrentSessionPlaytime-java.util.UUID-">fetchCurrentSessionPlaytime</a></span>(java.util.UUID playerUUID)</code>
|
|
<div class="block">Get playtime of current online session.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchLastSeen-java.util.UUID-java.util.UUID-">fetchLastSeen</a></span>(java.util.UUID playerUUID,
|
|
java.util.UUID serverUUID)</code>
|
|
<div class="block">Fetch last seen Epoch ms for a player on a server.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>java.util.Optional<java.lang.String></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchNameOf-java.util.UUID-">fetchNameOf</a></span>(java.util.UUID playerUUID)</code> </td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchPlaytime-java.util.UUID-java.util.UUID-long-long-">fetchPlaytime</a></span>(java.util.UUID playerUUID,
|
|
java.util.UUID serverUUID,
|
|
long after,
|
|
long before)</code>
|
|
<div class="block">Fetch playtime of a player on a server.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>java.util.Set<java.util.UUID></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchServerUUIDs--">fetchServerUUIDs</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>java.util.Optional<java.util.UUID></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchUUIDOf-java.lang.String-">fetchUUIDOf</a></span>(java.lang.String playerName)</code> </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="fetchPlaytime-java.util.UUID-java.util.UUID-long-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchPlaytime</h4>
|
|
<pre>long fetchPlaytime(java.util.UUID playerUUID,
|
|
java.util.UUID serverUUID,
|
|
long after,
|
|
long before)</pre>
|
|
<div class="block">Fetch playtime of a player on a server.
|
|
<p>
|
|
Returns 0 for any non existing players or servers.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>serverUUID</code> - UUID of the Plan server.</dd>
|
|
<dd><code>after</code> - Data after this Epoch ms should be fetched</dd>
|
|
<dd><code>before</code> - Data before this Epoch ms should be fetched</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Milliseconds the player has played with the defined parameters.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchCurrentSessionPlaytime-java.util.UUID-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchCurrentSessionPlaytime</h4>
|
|
<pre>long fetchCurrentSessionPlaytime(java.util.UUID playerUUID)</pre>
|
|
<div class="block">Get playtime of current online session.
|
|
<p>
|
|
Requires Capability QUERY_API_ACTIVE_SESSION_PLAYTIME</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Milliseconds the player has played during current online session. 0 if player is offline.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchLastSeen-java.util.UUID-java.util.UUID-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchLastSeen</h4>
|
|
<pre>long fetchLastSeen(java.util.UUID playerUUID,
|
|
java.util.UUID serverUUID)</pre>
|
|
<div class="block">Fetch last seen Epoch ms for a player on a server.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>serverUUID</code> - UUID of the Plan server.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Epoch ms the player was last seen, 0 if player has not played on server.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchServerUUIDs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchServerUUIDs</h4>
|
|
<pre>java.util.Set<java.util.UUID> fetchServerUUIDs()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchUUIDOf-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchUUIDOf</h4>
|
|
<pre>java.util.Optional<java.util.UUID> fetchUUIDOf(java.lang.String playerName)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchNameOf-java.util.UUID-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchNameOf</h4>
|
|
<pre>java.util.Optional<java.lang.String> fetchNameOf(java.util.UUID playerUUID)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="doesDBHaveTable-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>doesDBHaveTable</h4>
|
|
<pre>boolean doesDBHaveTable(java.lang.String table)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="doesDBHaveTableColumn-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>doesDBHaveTableColumn</h4>
|
|
<pre>boolean doesDBHaveTableColumn(java.lang.String table,
|
|
java.lang.String column)</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-all.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="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/djrapitops/plan/query/CommonQueries.html" target="_top">Frames</a></li>
|
|
<li><a href="CommonQueries.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>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 name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|