Packages

object completions extends Helpful

Annotations
@Summary(s = "Monitor progress of commands", flag = FeatureFlag.Testing) @Group(name = "Command Completions")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. completions
  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. def end(): LedgerOffset
    Annotations
    @Summary(s = "Read the current command completion offset", flag = FeatureFlag.Testing)
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  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. def list(partyId: PartyId, atLeastNumCompletions: Int, offset: LedgerOffset, applicationId: String = applicationId, timeout: NonNegativeDuration = timeouts.ledgerCommand, filter: (Completion) => Boolean = _ => true): Seq[Completion]
    Annotations
    @Summary(s = "Lists command completions following the specified offset", flag = FeatureFlag.Testing) @Description(s = """If the participant has been pruned via `pruning.prune` and if `offset` is lower than
    |the pruning offset, this command fails with a `NOT_FOUND` error."""    )
  15. def list_with_checkpoint(partyId: PartyId, atLeastNumCompletions: Int, offset: LedgerOffset, applicationId: String = applicationId, timeout: NonNegativeDuration = timeouts.ledgerCommand, filter: (Completion) => Boolean = _ => true): Seq[(Completion, Option[Checkpoint])]
    Annotations
    @Summary(s = "Lists command completions following the specified offset along with the checkpoints included in the completions", flag = FeatureFlag.Testing) @Description(s = """If the participant has been pruned via `pruning.prune` and if `offset` is lower than
    |the pruning offset, this command fails with a `NOT_FOUND` error."""    )
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def subscribe(observer: StreamObserver[Completion], parties: Seq[PartyId], beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), applicationId: String = applicationId): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the command completion stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the command completion stream and passes command completions to `observer` until
    |the stream is completed.
    |Only completions for parties in `parties` will be returned.
    |The returned completions start at `beginOffset` (default: `LEDGER_BEGIN`).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error."""    )
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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