PluginAPI/docs/xyz/etztech/core/web/Http.html

403 lines
16 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_202) on Thu Aug 15 09:00:43 CDT 2019 -->
<title>Http</title>
<meta name="date" content="2019-08-15">
<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="Http";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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&nbsp;Class</li>
<li><a href="../../../../xyz/etztech/core/web/Http.Method.html" title="enum in xyz.etztech.core.web"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?xyz/etztech/core/web/Http.html" target="_top">Frames</a></li>
<li><a href="Http.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">xyz.etztech.core.web</div>
<h2 title="Class Http" class="title">Class Http</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>xyz.etztech.core.web.Http</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Http</span>
extends java.lang.Object</pre>
<div class="block">A static class used for HTTP calls within a plugin</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">Class 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="../../../../xyz/etztech/core/web/Http.Method.html" title="enum in xyz.etztech.core.web">Http.Method</a></span></code>
<div class="block">Available HTTP methods to use with the raw HTTP method</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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">&nbsp;</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="../../../../xyz/etztech/core/web/Http.html#Http--">Http</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../xyz/etztech/core/web/Http.html#asyncGet-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-">asyncGet</a></span>(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../xyz/etztech/core/web/Http.html#asyncGetCallback-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-xyz.etztech.core.web.ICallback-">asyncGetCallback</a></span>(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data,
<a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web">ICallback</a>&nbsp;callback)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../xyz/etztech/core/web/Http.html#asyncPost-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-">asyncPost</a></span>(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../xyz/etztech/core/web/Http.html#asyncPostCallback-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-xyz.etztech.core.web.ICallback-">asyncPostCallback</a></span>(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data,
<a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web">ICallback</a>&nbsp;callback)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../xyz/etztech/core/web/Http.html#HTTP-java.lang.String-xyz.etztech.core.web.Http.Method-java.util.Map-">HTTP</a></span>(java.lang.String&nbsp;endpoint,
<a href="../../../../xyz/etztech/core/web/Http.Method.html" title="enum in xyz.etztech.core.web">Http.Method</a>&nbsp;method,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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="Http--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Http</h4>
<pre>public&nbsp;Http()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="asyncGet-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncGet</h4>
<pre>public static&nbsp;void&nbsp;asyncGet(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The calling plugin</dd>
<dd><code>url</code> - The URL to call</dd>
<dd><code>data</code> - A map of parameters</dd>
</dl>
</li>
</ul>
<a name="asyncGetCallback-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-xyz.etztech.core.web.ICallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncGetCallback</h4>
<pre>public static&nbsp;void&nbsp;asyncGetCallback(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data,
<a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web">ICallback</a>&nbsp;callback)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The calling plugin</dd>
<dd><code>url</code> - The URL to call</dd>
<dd><code>data</code> - A map of parameters</dd>
<dd><code>callback</code> - A class implementing an ICallBack to run upon completion</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web"><code>ICallback</code></a></dd>
</dl>
</li>
</ul>
<a name="asyncPost-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncPost</h4>
<pre>public static&nbsp;void&nbsp;asyncPost(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The calling plugin</dd>
<dd><code>url</code> - The URL to call</dd>
<dd><code>data</code> - A map of parameters</dd>
</dl>
</li>
</ul>
<a name="asyncPostCallback-org.bukkit.plugin.Plugin-java.lang.String-java.util.Map-xyz.etztech.core.web.ICallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncPostCallback</h4>
<pre>public static&nbsp;void&nbsp;asyncPostCallback(org.bukkit.plugin.Plugin&nbsp;plugin,
java.lang.String&nbsp;url,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data,
<a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web">ICallback</a>&nbsp;callback)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The calling plugin</dd>
<dd><code>url</code> - The URL to call</dd>
<dd><code>data</code> - A map of parameters</dd>
<dd><code>callback</code> - A class implementing an ICallBack to run upon completion</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../xyz/etztech/core/web/ICallback.html" title="interface in xyz.etztech.core.web"><code>ICallback</code></a></dd>
</dl>
</li>
</ul>
<a name="HTTP-java.lang.String-xyz.etztech.core.web.Http.Method-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HTTP</h4>
<pre>public static&nbsp;java.lang.String&nbsp;HTTP(java.lang.String&nbsp;endpoint,
<a href="../../../../xyz/etztech/core/web/Http.Method.html" title="enum in xyz.etztech.core.web">Http.Method</a>&nbsp;method,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;data)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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-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&nbsp;Class</li>
<li><a href="../../../../xyz/etztech/core/web/Http.Method.html" title="enum in xyz.etztech.core.web"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?xyz/etztech/core/web/Http.html" target="_top">Frames</a></li>
<li><a href="Http.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>