Packages

object transfer extends Helpful

Annotations
@Summary(s = "Composability related functionality", flag = FeatureFlag.Preview) @Group(name = "Transfer")
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. transfer
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def execute(submittingParty: PartyId, contractId: LfContractId, sourceDomain: DomainAlias, targetDomain: DomainAlias): Unit
    Annotations
    @Summary(s = "Transfer the contract from the origin domain to the target domain", flag = FeatureFlag.Preview) @Description(s = "Macro that first calls transfer_out and then transfer_in. No error handling is done.")
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  12. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  13. def in(submittingParty: PartyId, transferId: TransferId, targetDomain: DomainAlias, applicationId: LedgerApplicationId = LedgerApplicationId.assertFromString("AdminConsole"), submissionId: String = "", workflowId: String = "", commandId: String = ""): Unit
    Annotations
    @Summary(s = "Transfer-in a contract in transit to the target domain", flag = FeatureFlag.Preview) @Description(s = """Manually transfers a contract in transit into the target domain.
    The command returns when the transfer-in has completed successfully.
    If the transferExclusivityTimeout in the target domain's parameters is set to a positive value,
    all participants of all stakeholders connected to both origin and target domain will attempt to transfer-in
    the contract automatically after the exclusivity timeout has elapsed.
    An application-id can be specified to uniquely identifies the application that have issued the transfer,
    otherwise the default value will be used. An optional submission id can be set by the committer to the value
    of their choice that allows an application to correlate completions to its submissions."""
    )
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def lookup_contract_domain(contractIds: LfContractId*): Map[LfContractId, String]
    Annotations
    @Summary(s = "Lookup the active domain for the provided contracts", flag = FeatureFlag.Preview)
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def out(submittingParty: PartyId, contractId: LfContractId, sourceDomain: DomainAlias, targetDomain: DomainAlias, applicationId: LedgerApplicationId = LedgerApplicationId.assertFromString("AdminConsole"), submissionId: String = "", workflowId: String = "", commandId: String = ""): TransferId
    Annotations
    @Summary(s = "Transfer-out a contract from the source domain with destination target domain", flag = FeatureFlag.Preview) @Description(s = """Transfers the given contract out of the source domain with destination target domain.
    The command returns the ID of the transfer when the transfer-out has completed successfully.
    The contract is in transit until the transfer-in has completed on the target domain.
    The submitting party must be a stakeholder of the contract and the participant must have submission rights
    for the submitting party on the source domain. It must also be connected to the target domain.
    An application-id can be specified to uniquely identify the application that have issued the transfer,
    otherwise the default value will be used. An optional submission id can be set by the committer to the value
    of their choice that allows an application to correlate completions to its submissions."""
    )
  20. def search(targetDomain: DomainAlias, filterSourceDomain: Option[DomainAlias], filterTimestamp: Option[Instant], filterSubmittingParty: Option[PartyId], limit: PositiveInt = defaultLimit): Seq[TransferSearchResult]
    Annotations
    @Summary(s = "Search the currently in-flight transfers", flag = FeatureFlag.Preview) @Description(s = "Returns all in-flight transfers with the given target domain that match the filters, but no more than the limit specifies.")
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped