Class Order

  • All Implemented Interfaces:
    tbdex.sdk.http.WalletUpdateMessage , tbdex.sdk.messages.Message

    
    public final class Order
     implements Message, WalletUpdateMessage
                        

    Represents an Order message in the tbDEX protocol.

    An Order message is sent by Alice to a PFI to execute a transaction based on a previously provided quote.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Order.Companion
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final MessageMetadata getMetadata() Metadata about the message, including sender, recipient, and protocol information.
      final String getSignature() The signature verifying the authenticity and integrity of the Order message.
      final String toJsonString() Serializes the Order to a JSON string.
      final Unit sign(BearerDid bearerDid) Signs the Order using the provided Bearer DID.
      final Unit verify() Verifies the Order's signature and validity.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getMetadata

         final MessageMetadata getMetadata()

        Metadata about the message, including sender, recipient, and protocol information.

      • getSignature

         final String getSignature()

        The signature verifying the authenticity and integrity of the Order message.

      • toJsonString

         final String toJsonString()

        Serializes the Order to a JSON string.

        Returns:

        The serialized JSON string of the Order.

      • sign

         final Unit sign(BearerDid bearerDid)

        Signs the Order using the provided Bearer DID.

        Parameters:
        bearerDid - The Bearer DID used to sign the Order.
      • verify

         final Unit verify()

        Verifies the Order's signature and validity.