mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2025-02-25 15:10:18 +01:00
Code Issues Projects Releases Packages Wiki Activity

PaymentSession: javadoc formatting.

Browse source
This commit is contained in:
Mike Hearn 2014-02-10 13:14:48 +01:00
parent e7ea8483e4
commit 51c0f283e2
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
core/src/main/java/com/google/bitcoin/protocols/payments/PaymentSession.java
View file

@ -56,20 +56,19 @@ import java.util.concurrent.Callable;
* <li>Directly with a {@link Protos.PaymentRequest} object</li> * <li>Directly with a {@link Protos.PaymentRequest} object</li>
* </ul> * </ul>
* *
* If initialized with a BitcoinURI or a url, a network request is made for the payment request object and a * <p>If initialized with a BitcoinURI or a url, a network request is made for the payment request object and a
* ListenableFuture is returned that will be notified with the PaymentSession object after it is downloaded. * ListenableFuture is returned that will be notified with the PaymentSession object after it is downloaded.</p>
* *
* Once the PaymentSession is initialized, typically a wallet application will prompt the user to confirm that the * <p>Once the PaymentSession is initialized, typically a wallet application will prompt the user to confirm that the
* amount and recipient are correct, perform any additional steps, and then construct a list of transactions to pass to * amount and recipient are correct, perform any additional steps, and then construct a list of transactions to pass to
* the sendPayment method. * the sendPayment method.</p>
* *
* Call sendPayment with a list of transactions that will be broadcast. A {@link Protos.Payment} message will be sent to * <p>Call sendPayment with a list of transactions that will be broadcast. A {@link Protos.Payment} message will be sent
* the merchant if a payment url is provided in the PaymentRequest. * to the merchant if a payment url is provided in the PaymentRequest. NOTE: sendPayment does NOT broadcast the
* NOTE: sendPayment does NOT broadcast the transactions to the bitcoin network. * transactions to the bitcoin network. Instead it returns a ListenableFuture that will be notified when a
* * {@link Protos.PaymentACK} is received from the merchant. Typically a wallet will show the message to the user
* sendPayment returns a ListenableFuture that will be notified when a {@link Protos.PaymentACK} is received from the * as a confirmation message that the payment is now "processing" or that an error occurred, and then broadcast the
* merchant. Typically a wallet will show the message to the user as a confirmation message that the payment is now * tx itself later if needed.</p>
* "processing" or that an error occurred.
* *
* @author Kevin Greene * @author Kevin Greene
* @see <a href="https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki">BIP 0070</a> * @see <a href="https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki">BIP 0070</a>