Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Sep 4, 2024
1 parent 4755e50 commit 65408d3
Show file tree
Hide file tree
Showing 11 changed files with 597 additions and 71 deletions.
382 changes: 312 additions & 70 deletions docs/com/bitpay/sdk/Client.html
View file

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions docs/com/bitpay/sdk/class-use/Client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Client.html" title="class in com
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByConfigFilePath-com.bitpay.sdk.ConfigFilePath-java.lang.String-">createClientByConfigFilePath</a></span>(<a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="class in com.bitpay.sdk">ConfigFilePath</a>&nbsp;configFilePath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByPrivateKey-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.Environment-">createClientByPrivateKey</a></span>(<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByPrivateKey-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.Environment-java.lang.String-">createClientByPrivateKey</a></span>(<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token)</code>
Expand All @@ -131,6 +147,21 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Client.html" title="class in com
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-java.lang.String-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-java.lang.String-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down
15 changes: 15 additions & 0 deletions docs/com/bitpay/sdk/class-use/ConfigFilePath.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="clas
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByConfigFilePath-com.bitpay.sdk.ConfigFilePath-java.lang.String-">createClientByConfigFilePath</a></span>(<a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="class in com.bitpay.sdk">ConfigFilePath</a>&nbsp;configFilePath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
Expand All @@ -131,6 +138,14 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="clas
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.ConfigFilePath-org.apache.http.HttpHost-org.apache.http.client.CredentialsProvider-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="class in com.bitpay.sdk">ConfigFilePath</a>&nbsp;configFilePath,
org.apache.http.HttpHost&nbsp;proxy,
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down
34 changes: 34 additions & 0 deletions docs/com/bitpay/sdk/class-use/Environment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Environment.html" title="enum in
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByPrivateKey-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.Environment-java.lang.String-">createClientByPrivateKey</a></span>(<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-java.lang.String-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#getBaseUrl-com.bitpay.sdk.Environment-">getBaseUrl</a></span>(<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
Expand Down Expand Up @@ -189,11 +206,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Environment.html" title="enum in
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.Environment-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-org.apache.http.HttpHost-org.apache.http.client.CredentialsProvider-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
org.apache.http.HttpHost&nbsp;proxyDetails,
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-">Client</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
<div class="block">Constructor for POS facade.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for POS facade.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down
28 changes: 28 additions & 0 deletions docs/com/bitpay/sdk/class-use/PosToken.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,21 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PosToken.html" title="class in c
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-java.lang.String-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createPosClient-com.bitpay.sdk.PosToken-java.lang.String-">createPosClient</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create pos (light) client.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
Expand All @@ -136,6 +151,19 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PosToken.html" title="class in c
<div class="block">Constructor for POS facade.</div>
</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.PosToken-com.bitpay.sdk.Environment-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for POS facade.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.PosToken-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/PosToken.html" title="class in com.bitpay.sdk">PosToken</a>&nbsp;token,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for POS facade.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down
19 changes: 19 additions & 0 deletions docs/com/bitpay/sdk/class-use/PrivateKey.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,15 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#createClientByPrivateKey-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.Environment-java.lang.String-">createClientByPrivateKey</a></span>(<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Create standard client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.bitcoinj.core.ECKey</code></td>
<td class="colLast"><span class="typeNameLabel">Client.</span><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#getEcKey-com.bitpay.sdk.PrivateKey-">getEcKey</a></span>(<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey)</code>
<div class="block">Gets ECKey.</div>
Expand All @@ -135,6 +144,16 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/bitpay/sdk/Client.html#Client-com.bitpay.sdk.Environment-com.bitpay.sdk.PrivateKey-com.bitpay.sdk.util.TokenContainer-org.apache.http.HttpHost-org.apache.http.client.CredentialsProvider-java.lang.String-">Client</a></span>(<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
org.apache.http.HttpHost&nbsp;proxyDetails,
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;platformInfo)</code>
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down
Loading

0 comments on commit 65408d3

Please sign in to comment.