Packages

object users extends Helpful

Annotations
@Summary(s = "Manage Ledger Api Users", flag = FeatureFlag.Testing) @Group(name = "Ledger Api Users")
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. users
  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. def create(id: String, actAs: Set[LfPartyId], primaryParty: Option[LfPartyId] = None, readAs: Set[LfPartyId] = Set(), participantAdmin: Boolean = false): LedgerApiUser
    Annotations
    @Summary(s = "Create a user with the given id", flag = FeatureFlag.Testing) @Description(s = """Users are used to dynamically managing the rights given to Daml applications.
    |They allow us to link a stable local identifier (of an application) with a set of parties.
    id: the id used to identify the given user
    actAs: the set of parties this user is allowed to act as
    primaryParty: the optional party that should be linked to this user by default
    readAs: the set of parties this user is allowed to read as
    participantAdmin: flag (default false) indicating if the user is allowed to use the admin commands of the Ledger Api
    """
    )
  7. def delete(id: String): Unit
    Annotations
    @Summary(s = "Delete user", flag = FeatureFlag.Testing) @Description(s = """Delete a user.""")
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  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. def list(filterUser: String = "", pageToken: String = "", pageSize: Int = 100): ListLedgerApiUsersResult
    Annotations
    @Summary(s = "List users", flag = FeatureFlag.Testing) @Description(s = """List users of this participant node
    filterUser: filter results using the given filter string
    pageToken: used for pagination (the result contains a page token if there are further pages)
    pageSize: default page size before the filter is applied"""
    )
  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. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. object rights extends Helpful
    Annotations
    @Summary(s = "Manage Ledger Api User Rights", flag = FeatureFlag.Testing) @Group(name = "Ledger Api User Rights")

Deprecated Value Members

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

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped