InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder (lightningj 0.17.4-Beta API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

InvoicesOuterClass.AddHoldInvoiceRequest, InvoicesOuterClass.AddHoldInvoiceRequest.Builder

Enclosing class:

InvoicesOuterClass
```
public static interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCltvExpiry()` Delta to use for the time-lock of the CLTV extended to the final hop.
`com.google.protobuf.ByteString`	`getDescriptionHash()` Hash (SHA-256) of a description of the payment.
`long`	`getExpiry()` Payment request expiry time in seconds.
`java.lang.String`	`getFallbackAddr()` Fallback on-chain address.
`com.google.protobuf.ByteString`	`getFallbackAddrBytes()` Fallback on-chain address.
`com.google.protobuf.ByteString`	`getHash()` The hash of the preimage
`java.lang.String`	`getMemo()` An optional memo to attach along with the invoice.
`com.google.protobuf.ByteString`	`getMemoBytes()` An optional memo to attach along with the invoice.
`boolean`	`getPrivate()` Whether this invoice should include routing hints for private channels.
`LightningApi.RouteHint`	`getRouteHints(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`int`	`getRouteHintsCount()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`java.util.List<LightningApi.RouteHint>`	`getRouteHintsList()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`LightningApi.RouteHintOrBuilder`	`getRouteHintsOrBuilder(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`java.util.List<? extends LightningApi.RouteHintOrBuilder>`	`getRouteHintsOrBuilderList()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`long`	`getValue()` The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
`long`	`getValueMsat()` The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getMemo

java.lang.String getMemo()


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Returns:: The memo.

getMemoBytes

com.google.protobuf.ByteString getMemoBytes()


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Returns:: The bytes for memo.

getHash

com.google.protobuf.ByteString getHash()

 The hash of the preimage

bytes hash = 2;

Returns:: The hash.

getValue

long getValue()


The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.

int64 value = 3;

Returns:: The value.

getValueMsat

long getValueMsat()


The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.

int64 value_msat = 10;

Returns:: The valueMsat.

getDescriptionHash

com.google.protobuf.ByteString getDescriptionHash()


Hash (SHA-256) of a description of the payment. Used if the description of
payment (memo) is too long to naturally fit within the description field
of an encoded payment request.

bytes description_hash = 4;

Returns:: The descriptionHash.

getExpiry

long getExpiry()

 Payment request expiry time in seconds. Default is 86400 (24 hours).

int64 expiry = 5;

Returns:: The expiry.

getFallbackAddr

java.lang.String getFallbackAddr()

 Fallback on-chain address.

string fallback_addr = 6;

Returns:: The fallbackAddr.

getFallbackAddrBytes

com.google.protobuf.ByteString getFallbackAddrBytes()

 Fallback on-chain address.

string fallback_addr = 6;

Returns:: The bytes for fallbackAddr.

getCltvExpiry

long getCltvExpiry()

 Delta to use for the time-lock of the CLTV extended to the final hop.

uint64 cltv_expiry = 7;

Returns:: The cltvExpiry.