Package tbdex.sdk.messages
Class OrderStatus
-
- All Implemented Interfaces:
-
tbdex.sdk.http.ReplyToMessage,tbdex.sdk.messages.Message
public final class OrderStatus implements Message, ReplyToMessage
Represents an Order Status message in the tbDEX protocol.
An Order Status message is sent by a PFI to Alice to communicate the current status of an ongoing order or exchange process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classOrderStatus.Companion
-
Field Summary
Fields Modifier and Type Field Description private final MessageMetadatametadataprivate final OrderStatusDatadataprivate final Stringsignaturepublic final static OrderStatus.CompanionCompanion
-
Method Summary
Modifier and Type Method Description final MessageMetadatagetMetadata()Metadata about the message, including sender, recipient, and protocol information. final OrderStatusDatagetData()The data part of the Order Status, such as the current status of the order. final StringgetSignature()The signature verifying the authenticity and integrity of the Order Status message. final StringtoJsonString()Serializes the Order Status to a JSON string. final Unitsign(BearerDid bearerDid)Signs the Order Status using the provided Bearer DID. final Unitverify()Verifies the Order Status's signature and validity. -
-
Method Detail
-
getMetadata
final MessageMetadata getMetadata()
Metadata about the message, including sender, recipient, and protocol information.
-
getData
final OrderStatusData getData()
The data part of the Order Status, such as the current status of the order.
-
getSignature
final String getSignature()
The signature verifying the authenticity and integrity of the Order Status message.
-
toJsonString
final String toJsonString()
Serializes the Order Status to a JSON string.
- Returns:
The serialized JSON string of the Order Status.
-
sign
final Unit sign(BearerDid bearerDid)
Signs the Order Status using the provided Bearer DID.
- Parameters:
bearerDid- The Bearer DID used to sign the Order Status.
-
-
-
-