Skip to content

Commit 65408d3

Browse files
author
GitHub Actions
committed
Update javadoc
1 parent 4755e50 commit 65408d3

File tree

11 files changed

+597
-71
lines changed

11 files changed

+597
-71
lines changed

‎docs/com/bitpay/sdk/Client.html‎

Lines changed: 312 additions & 70 deletions
Large diffs are not rendered by default.

‎docs/com/bitpay/sdk/class-use/Client.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Client.html" title="class in com
112112
</tr>
113113
<tr class="rowColor">
114114
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
115+
<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,
116+
<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>
117+
<div class="block">Create standard client.</div>
118+
</td>
119+
</tr>
120+
<tr class="altColor">
121+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
115122
<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,
116123
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
117124
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
118125
<div class="block">Create standard client.</div>
119126
</td>
120127
</tr>
128+
<tr class="rowColor">
129+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
130+
<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,
131+
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
132+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
133+
<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>
134+
<div class="block">Create standard client.</div>
135+
</td>
136+
</tr>
121137
<tr class="altColor">
122138
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
123139
<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>
@@ -131,6 +147,21 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Client.html" title="class in com
131147
<div class="block">Create pos (light) client.</div>
132148
</td>
133149
</tr>
150+
<tr class="altColor">
151+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
152+
<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,
153+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
154+
<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>
155+
<div class="block">Create pos (light) client.</div>
156+
</td>
157+
</tr>
158+
<tr class="rowColor">
159+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
160+
<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,
161+
<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>
162+
<div class="block">Create pos (light) client.</div>
163+
</td>
164+
</tr>
134165
</tbody>
135166
</table>
136167
</li>

‎docs/com/bitpay/sdk/class-use/ConfigFilePath.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,13 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="clas
116116
<div class="block">Create standard client.</div>
117117
</td>
118118
</tr>
119+
<tr class="altColor">
120+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
121+
<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,
122+
<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>
123+
<div class="block">Create standard client.</div>
124+
</td>
125+
</tr>
119126
</tbody>
120127
</table>
121128
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
@@ -131,6 +138,14 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/ConfigFilePath.html" title="clas
131138
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
132139
</td>
133140
</tr>
141+
<tr class="rowColor">
142+
<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,
143+
org.apache.http.HttpHost&nbsp;proxy,
144+
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
145+
<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>
146+
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
147+
</td>
148+
</tr>
134149
</tbody>
135150
</table>
136151
</li>

‎docs/com/bitpay/sdk/class-use/Environment.html‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Environment.html" title="enum in
148148
</tr>
149149
<tr class="rowColor">
150150
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
151+
<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,
152+
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
153+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
154+
<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>
155+
<div class="block">Create standard client.</div>
156+
</td>
157+
</tr>
158+
<tr class="altColor">
159+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
151160
<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,
152161
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
153162
<div class="block">Create pos (light) client.</div>
154163
</td>
155164
</tr>
165+
<tr class="rowColor">
166+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
167+
<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,
168+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
169+
<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>
170+
<div class="block">Create pos (light) client.</div>
171+
</td>
172+
</tr>
156173
<tr class="altColor">
157174
<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>
158175
<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>
@@ -189,11 +206,28 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/Environment.html" title="enum in
189206
</td>
190207
</tr>
191208
<tr class="rowColor">
209+
<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,
210+
<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
211+
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
212+
org.apache.http.HttpHost&nbsp;proxyDetails,
213+
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
214+
<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>
215+
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
216+
</td>
217+
</tr>
218+
<tr class="altColor">
192219
<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,
193220
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment)</code>
194221
<div class="block">Constructor for POS facade.</div>
195222
</td>
196223
</tr>
224+
<tr class="rowColor">
225+
<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,
226+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
227+
<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>
228+
<div class="block">Constructor for POS facade.</div>
229+
</td>
230+
</tr>
197231
</tbody>
198232
</table>
199233
</li>

‎docs/com/bitpay/sdk/class-use/PosToken.html‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,21 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PosToken.html" title="class in c
117117
<div class="block">Create pos (light) client.</div>
118118
</td>
119119
</tr>
120+
<tr class="altColor">
121+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
122+
<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,
123+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
124+
<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>
125+
<div class="block">Create pos (light) client.</div>
126+
</td>
127+
</tr>
128+
<tr class="rowColor">
129+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
130+
<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,
131+
<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>
132+
<div class="block">Create pos (light) client.</div>
133+
</td>
134+
</tr>
120135
</tbody>
121136
</table>
122137
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
@@ -136,6 +151,19 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PosToken.html" title="class in c
136151
<div class="block">Constructor for POS facade.</div>
137152
</td>
138153
</tr>
154+
<tr class="altColor">
155+
<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,
156+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
157+
<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>
158+
<div class="block">Constructor for POS facade.</div>
159+
</td>
160+
</tr>
161+
<tr class="rowColor">
162+
<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,
163+
<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>
164+
<div class="block">Constructor for POS facade.</div>
165+
</td>
166+
</tr>
139167
</tbody>
140168
</table>
141169
</li>

‎docs/com/bitpay/sdk/class-use/PrivateKey.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,15 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in
113113
</td>
114114
</tr>
115115
<tr class="rowColor">
116+
<td class="colFirst"><code>static <a href="../../../../com/bitpay/sdk/Client.html" title="class in com.bitpay.sdk">Client</a></code></td>
117+
<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,
118+
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
119+
<a href="../../../../com/bitpay/sdk/Environment.html" title="enum in com.bitpay.sdk">Environment</a>&nbsp;environment,
120+
<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>
121+
<div class="block">Create standard client.</div>
122+
</td>
123+
</tr>
124+
<tr class="altColor">
116125
<td class="colFirst"><code>protected org.bitcoinj.core.ECKey</code></td>
117126
<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>
118127
<div class="block">Gets ECKey.</div>
@@ -135,6 +144,16 @@ <h3>Uses of <a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in
135144
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
136145
</td>
137146
</tr>
147+
<tr class="rowColor">
148+
<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,
149+
<a href="../../../../com/bitpay/sdk/PrivateKey.html" title="class in com.bitpay.sdk">PrivateKey</a>&nbsp;privateKey,
150+
<a href="../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;tokenContainer,
151+
org.apache.http.HttpHost&nbsp;proxyDetails,
152+
org.apache.http.client.CredentialsProvider&nbsp;proxyCredentials,
153+
<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>
154+
<div class="block">Constructor for use if the keys and SIN are managed by this library.</div>
155+
</td>
156+
</tr>
138157
</tbody>
139158
</table>
140159
</li>

0 commit comments

Comments
 (0)