Packages

object parties extends Helpful

Annotations
@Summary(s = "Manage parties through the Ledger API", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party Management")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. parties
  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. def allocate(party: String, annotations: Map[String, String] = Map.empty, identityProviderId: String = "", synchronizerId: Option[SynchronizerId] = None, userId: String = ""): PartyDetails
    Annotations
    @Summary(s = "Allocate a new party", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Allocates a new party on the ledger.
    party: a hint for generating the party identifier
    annotations: key-value pairs associated with this party and stored locally on this Ledger API server
    identityProviderId: identity provider id
    synchronizerId: The synchronizer on which the party should be allocated.
    The participant must be connected to the synchronizer.
    The parameter may be omitted if the participant is connected to only one synchronizer."""    )
  5. def allocate_external(synchronizerId: SynchronizerId, transactions: Seq[(GenericTopologyTransaction, Seq[Signature])], multiSignatures: Seq[Signature]): AllocateExternalPartyResponse
    Annotations
    @Summary(s = "Allocate a new external party", flag = FeatureFlag.Preview) @Description(s = """Allocates a new external party on the ledger.
    synchronizerId: SynchronizerId on which to allocate the party
    transactions: onboarding transactions and their individual signatures
    multiSignatures: Signatures over the combined hash of all onboarding transactions"""    )
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def generate_topology(synchronizerId: SynchronizerId, partyHint: String, publicKey: SigningPublicKey, localParticipantObservationOnly: Boolean = false, otherConfirmingParticipantIds: Seq[ParticipantId] = Seq.empty, confirmationThreshold: NonNegativeInt = NonNegativeInt.zero, observingParticipantIds: Seq[ParticipantId] = Seq.empty): GenerateExternalPartyTopology
    Annotations
    @Summary(s = "Generate topology transactions for an external party", flag = FeatureFlag.Preview) @Description(s = """Convenience function to generate the necessary topology transactions.
    For more complex setups, please generate your topology transactions manually.
    synchronizerId: SynchronizerId for which the transactions should be generated.
    partyHint: the prefix for the party
    publicKey: the signing public key of the external party
    localParticipantObservationOnly: if true, then the allocating participant will only be an observer
    otherConfirmingParticipantUids: list of other participants that will be confirming daml transactions on behalf of the party
    confirmationThreshold: number of confirming participants which need to approve a daml transaction
    observingParticipantUids: list of other participants that should observe the transactions of the external party
    """    )
  11. def get(parties: Seq[PartyId], identityProviderId: String = "", failOnNotFound: Boolean = true): Map[PartyId, PartyDetails]
    Annotations
    @Summary(s = "Get party details for known parties", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Get party details for parties known by the Ledger API server for the given identity provider.
    identityProviderId: identity provider id"""    )
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. 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"))
  15. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def list(identityProviderId: String = ""): Seq[PartyDetails]
    Annotations
    @Summary(s = "List parties known by the Ledger API server", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Lists parties known by the Ledger API server.
    identityProviderId: identity provider id"""    )
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def update(party: Party, modifier: (PartyDetails) => PartyDetails, identityProviderId: String = ""): PartyDetails
    Annotations
    @Summary(s = "Update participant-local party details", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Currently you can update only the annotations.
    |You cannot update other user attributes.
    party: party to be updated,
    modifier: a function to modify the party details, e.g.: `partyDetails => { partyDetails.copy(annotations = partyDetails.annotations.updated("a", "b").removed("c")) }`
    identityProviderId: identity provider id"""    )
  24. def update_idp(party: PartyId, sourceIdentityProviderId: String, targetIdentityProviderId: String): Unit
    Annotations
    @Summary(s = "Update party's identity provider id", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Updates party's identity provider id.
    party: party to be updated
    sourceIdentityProviderId: source identity provider id
    targetIdentityProviderId: target identity provider id
    """    )
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped