Packages

object commands extends Helpful

Annotations
@Summary(s = "Submit commands", flag = FeatureFlag.Testing) @Group(name = "Command Submission")
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. commands
  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() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def failed(commandId: String = "", limit: PositiveInt = PositiveInt.tryCreate(10)): Seq[CommandStatus]
    Annotations
    @Summary(s = "Investigate failed commands", flag = FeatureFlag.Testing) @Description(s = """Same as status(..., state = CommandState.Failed).""")
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. def status(commandIdPrefix: String = "", state: CommandState = CommandState.STATE_UNSPECIFIED, limit: PositiveInt = PositiveInt.tryCreate(10)): Seq[CommandStatus]
    Annotations
    @Summary(s = "Investigate successful and failed commands", flag = FeatureFlag.Testing) @Description(s = """Find the status of commands. Note that only recent commands which are kept in memory will be returned.""")
  18. def submit(actAs: Seq[PartyId], commands: Seq[Command], workflowId: String = "", commandId: String = "", optTimeout: Option[NonNegativeDuration] = Some(timeouts.ledgerCommand), deduplicationPeriod: Option[DeduplicationPeriod] = None, submissionId: String = "", minLedgerTimeAbs: Option[Instant] = None, readAs: Seq[PartyId] = Seq.empty, disclosedContracts: Seq[DisclosedContract] = Seq.empty, applicationId: String = applicationId, userPackageSelectionPreference: Seq[LfPackageId] = Seq.empty): TransactionTree
    Annotations
    @Summary(s = "Submit command and wait for the resulting transaction, returning the transaction tree or failing otherwise", flag = FeatureFlag.Testing) @Description(s = """Submits a command on behalf of the `actAs` parties, waits for the resulting transaction to commit and returns it.
    | If the timeout is set, it also waits for the transaction to appear at all other configured
    | participants who were involved in the transaction. The call blocks until the transaction commits or fails;
    | the timeout only specifies how long to wait at the other participants.
    | Fails if the transaction doesn't commit, or if it doesn't become visible to the involved participants in
    | the allotted time.
    | Note that if the optTimeout is set and the involved parties are concurrently enabled/disabled or their
    | participants are connected/disconnected, the command may currently result in spurious timeouts or may
    | return before the transaction appears at all the involved participants."""
    )
  19. def submit_async(actAs: Seq[PartyId], commands: Seq[Command], workflowId: String = "", commandId: String = "", deduplicationPeriod: Option[DeduplicationPeriod] = None, submissionId: String = "", minLedgerTimeAbs: Option[Instant] = None, readAs: Seq[PartyId] = Seq.empty, disclosedContracts: Seq[DisclosedContract] = Seq.empty, applicationId: String = applicationId, userPackageSelectionPreference: Seq[LfPackageId] = Seq.empty): Unit
    Annotations
    @Summary(s = "Submit command asynchronously", flag = FeatureFlag.Testing) @Description(s = """Provides access to the command submission service of the Ledger API.
    |See https://docs.daml.com/app-dev/services.html for documentation of the parameters."""
    )
  20. def submit_flat(actAs: Seq[PartyId], commands: Seq[Command], workflowId: String = "", commandId: String = "", optTimeout: Option[NonNegativeDuration] = Some(timeouts.ledgerCommand), deduplicationPeriod: Option[DeduplicationPeriod] = None, submissionId: String = "", minLedgerTimeAbs: Option[Instant] = None, readAs: Seq[PartyId] = Seq.empty, disclosedContracts: Seq[DisclosedContract] = Seq.empty, applicationId: String = applicationId, userPackageSelectionPreference: Seq[LfPackageId] = Seq.empty): Transaction
    Annotations
    @Summary(s = "Submit command and wait for the resulting transaction, returning the flattened transaction or failing otherwise", flag = FeatureFlag.Testing) @Description(s = """Submits a command on behalf of the `actAs` parties, waits for the resulting transaction to commit, and returns the "flattened" transaction.
    | If the timeout is set, it also waits for the transaction to appear at all other configured
    | participants who were involved in the transaction. The call blocks until the transaction commits or fails;
    | the timeout only specifies how long to wait at the other participants.
    | Fails if the transaction doesn't commit, or if it doesn't become visible to the involved participants in
    | the allotted time.
    | Note that if the optTimeout is set and the involved parties are concurrently enabled/disabled or their
    | participants are connected/disconnected, the command may currently result in spurious timeouts or may
    | return before the transaction appears at all the involved participants."""
    )
  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