Package tbdex.sdk.protocol.models

Object Close.Companion

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final Close create(String to, String from, String exchangeId, CloseData closeData, String protocol, String externalId) Creates a new Close message, autopopulating the id, creation time, and message kind.
      final Close parse(String payload) Takes an existing Close in the form of a json string and parses it into a Close object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • create

         final Close create(String to, String from, String exchangeId, CloseData closeData, String protocol, String externalId)

        Creates a new Close message, autopopulating the id, creation time, and message kind.

        Parameters:
        to - DID that the message is being sent to.
        from - DID of the sender.
        exchangeId - ID of the exchange.
        closeData - Specific parameters relevant to a Close.
        protocol - version of the tbdex protocol.
        externalId - external reference for the Close.
        Returns:

        Close instance.

      • parse

         final Close parse(String payload)

        Takes an existing Close in the form of a json string and parses it into a Close object. Validates object structure and performs an integrity check using the message signature.

        Parameters:
        payload - The Close as a json string.
        Returns:

        The json string parsed into a Close