Packages

final case class ListPaymentsRequest(includeIncomplete: Boolean = false, indexOffset: UInt64 = lnrpc.ListPaymentsRequest._typemapper_indexOffset.toCustom(0L), maxPayments: UInt64 = lnrpc.ListPaymentsRequest._typemapper_maxPayments.toCustom(0L), reversed: Boolean = false, countTotalPayments: Boolean = false, creationDateStart: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateStart.toCustom(0L), creationDateEnd: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateEnd.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPaymentsRequest] with Product with Serializable

includeIncomplete

If true, then return payments that have not yet fully completed. This means that pending payments, as well as failed payments will show up if this field is set to true. This flag doesn't change the meaning of the indices, which are tied to individual payments.

indexOffset

The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response. The index_offset is exclusive. In the case of a zero index_offset, the query will start with the oldest payment when paginating forwards, or will end with the most recent payment when paginating backwards.

maxPayments

The maximal number of payments returned in the response to this query.

reversed

If set, the payments returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards. The order of the returned payments is always oldest first (ascending index order).

countTotalPayments

If set, all payments (complete and incomplete, independent of the max_payments parameter) will be counted. Note that setting this to true will increase the run time of the call significantly on systems that have a lot of payments, as all of them have to be iterated through to be counted.

creationDateStart

If set, returns all invoices with a creation date greater than or equal to it. Measured in seconds since the unix epoch.

creationDateEnd

If set, returns all invoices with a creation date less than or equal to it. Measured in seconds since the unix epoch.

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ListPaymentsRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ListPaymentsRequest(includeIncomplete: Boolean = false, indexOffset: UInt64 = lnrpc.ListPaymentsRequest._typemapper_indexOffset.toCustom(0L), maxPayments: UInt64 = lnrpc.ListPaymentsRequest._typemapper_maxPayments.toCustom(0L), reversed: Boolean = false, countTotalPayments: Boolean = false, creationDateStart: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateStart.toCustom(0L), creationDateEnd: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateEnd.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    includeIncomplete

    If true, then return payments that have not yet fully completed. This means that pending payments, as well as failed payments will show up if this field is set to true. This flag doesn't change the meaning of the indices, which are tied to individual payments.

    indexOffset

    The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response. The index_offset is exclusive. In the case of a zero index_offset, the query will start with the oldest payment when paginating forwards, or will end with the most recent payment when paginating backwards.

    maxPayments

    The maximal number of payments returned in the response to this query.

    reversed

    If set, the payments returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards. The order of the returned payments is always oldest first (ascending index order).

    countTotalPayments

    If set, all payments (complete and incomplete, independent of the max_payments parameter) will be counted. Note that setting this to true will increase the run time of the call significantly on systems that have a lot of payments, as all of them have to be iterated through to be counted.

    creationDateStart

    If set, returns all invoices with a creation date greater than or equal to it. Measured in seconds since the unix epoch.

    creationDateEnd

    If set, returns all invoices with a creation date less than or equal to it. Measured in seconds since the unix epoch.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def companion: ListPaymentsRequest.type
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  7. val countTotalPayments: Boolean
  8. val creationDateEnd: UInt64
  9. val creationDateStart: UInt64
  10. def discardUnknownFields: ListPaymentsRequest
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  15. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  16. val includeIncomplete: Boolean
  17. val indexOffset: UInt64
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val maxPayments: UInt64
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reversed: Boolean
  25. def serializedSize: Int
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  28. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  29. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  30. def toProtoString: String
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  31. val unknownFields: UnknownFieldSet
  32. def update(ms: (Lens[ListPaymentsRequest, ListPaymentsRequest]) => Mutation[ListPaymentsRequest]*): ListPaymentsRequest
    Definition Classes
    Updatable
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. def withCountTotalPayments(__v: Boolean): ListPaymentsRequest
  37. def withCreationDateEnd(__v: UInt64): ListPaymentsRequest
  38. def withCreationDateStart(__v: UInt64): ListPaymentsRequest
  39. def withIncludeIncomplete(__v: Boolean): ListPaymentsRequest
  40. def withIndexOffset(__v: UInt64): ListPaymentsRequest
  41. def withMaxPayments(__v: UInt64): ListPaymentsRequest
  42. def withReversed(__v: Boolean): ListPaymentsRequest
  43. def withUnknownFields(__v: UnknownFieldSet): ListPaymentsRequest
  44. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  45. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ListPaymentsRequest → GeneratedMessage
  46. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped