Packages

object acs extends Helpful

Annotations
@Summary(s = "Read active contracts", flag = FeatureFlag.Testing) @Group(name = "Active Contracts")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. acs
  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 await_active_contract(party: PartyId, contractId: LfContractId, timeout: NonNegativeDuration = timeouts.ledgerCommand): Unit
    Annotations
    @Summary(s = "Wait until the party sees the given contract in the active contract service", flag = FeatureFlag.Testing) @Description(s = "Will throw an exception if the contract is not found to be active within the given timeout")
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def find_generic(partyId: PartyId, filter: (WrappedCreatedEvent) => Boolean, timeout: NonNegativeDuration = timeouts.ledgerCommand): WrappedCreatedEvent
    Annotations
    @Summary(s = "Generic search for contracts", flag = FeatureFlag.Testing) @Description(s = """This search function returns an untyped ledger-api event.
    |The find will wait until the contract appears or throw an exception once it times out."""    )
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. 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"))
  13. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def of_all(limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, timeout: NonNegativeDuration = timeouts.unbounded, identityProviderId: String = "", includeCreatedEventBlob: Boolean = false): Seq[WrappedCreatedEvent]
    Annotations
    @Summary(s = "List the set of active contracts for all parties hosted on this participant", flag = FeatureFlag.Testing) @Description(s = """This command will return the current set of active contracts for all parties.

    Supported arguments:
    - limit: limit (default set via canton.parameter.console)
    - verbose: whether the resulting events should contain detailed type information
    - filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
    - timeout: the maximum wait time for the complete acs to arrive
    - identityProviderId: limit the response to parties governed by the given identity provider
    - includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
    if the filterTemplate is non-empty
    """    )
  19. def of_party(party: PartyId, limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, timeout: NonNegativeDuration = timeouts.unbounded, includeCreatedEventBlob: Boolean = false): Seq[WrappedCreatedEvent]
    Annotations
    @Summary(s = "List the set of active contracts of a given party", flag = FeatureFlag.Testing) @Description(s = """This command will return the current set of active contracts for the given party.

    Supported arguments:
    - party: for which party you want to load the acs
    - limit: limit (default set via canton.parameter.console)
    - verbose: whether the resulting events should contain detailed type information
    - filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
    - timeout: the maximum wait time for the complete acs to arrive
    - includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
    if the filterTemplate is non-empty
    """    )
  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