Overview - Common API - Client API - Admin API - Runtime API
ParticipantRegistry
The ParticipantRegistry is used to manage a set of participants stored on the blockchain.
Details
Extends Registry
Module client
See also
- See Registry
Inherited Method Summary
| Supertype | Name | Returns | Description |
|---|---|---|---|
| Registry | remove | Promise |
Remove an asset with a given type and id from the registry |
| Registry | addAll | Promise |
Adds a list of new resources to the registry |
| Registry | updateAll | Promise |
Updates a list of resources in the registry |
| Registry | update | Promise |
Updates a resource in the registry |
| Registry | removeAll | Promise |
Removes a list of resources from the registry |
| Registry | add | Promise |
Adds a new resource to the registry |
| Registry | getAll | Promise |
Get all of the resources in the registry |
| Registry | get | Promise |
Get a specific resource in the registry |
| Registry | exists | Promise |
Determines whether a specific resource exists in the registry |
| Registry | resolveAll | Promise |
Get all of the resources in the registry, and resolve all of their relationships to other assets, participants, and transactions |
| Registry | resolve | Promise |
Get a specific resource in the registry, and resolve all of its relationships to other assets, participants, and transactions |
Method Details
Inherited methods
addAll
Promise addAll( resources )
Inherited from: Registry
Adds a list of new resources to the registry.
Returns
Promise - A promise that will be resolved when the resource is added to the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be added to the registry. |
add
Promise add( Resource resource )
Inherited from: Registry
Adds a new resource to the registry.
Returns
Promise - A promise that will be resolved when the resource is added to the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be added to the registry. |
updateAll
Promise updateAll( resources )
Inherited from: Registry
Updates a list of resources in the registry.
Returns
Promise - A promise that will be resolved when the resource is added to the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be updated in the asset registry. |
update
Promise update( Resource resource )
Inherited from: Registry
Updates a resource in the registry.
Returns
Promise - A promise that will be resolved when the resource is updated in the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be updated in the registry. |
removeAll
Promise removeAll( ; resources )
Inherited from: Registry
Removes a list of resources from the registry.
Returns
Promise - A promise that will be resolved when the resource is added to the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | ; | Yes | The resources, or the unique identifiers of the resources. |
remove
Promise remove( Resource; string resource )
Inherited from: Registry
Remove an asset with a given type and id from the registry.
Returns
Promise - A promise that will be resolved when the resource is removed from the registry.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource; string | Yes | The resource, or the unique identifier of the resource. |
getAll
Promise getAll( )
Inherited from: Registry
Get all of the resources in the registry.
Returns
Promise - A promise that will be resolved with an array of JSON objects representing the resources.
See also
Parameters
No parameters
get
Promise get( string id )
Inherited from: Registry
Get a specific resource in the registry.
Returns
Promise - A promise that will be resolved with a JSON object representing the resource.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the resource. |
exists
Promise exists( string id )
Inherited from: Registry
Determines whether a specific resource exists in the registry.
Returns
Promise - A promise that will be resolved with true/false depending on whether the resource exists.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the resource. |
resolveAll
Promise resolveAll( )
Inherited from: Registry
Get all of the resources in the registry, and resolve all of their relationships to other assets, participants, and transactions. The result is a JavaScript object, and should only be used for visualization purposes. You cannot use the add or update functions with a resolved resource.
Returns
Promise - A promise that will be resolved with an array of JavaScript objects representing the resources and all of their resolved relationships.
See also
Parameters
No parameters
resolve
Promise resolve( string id )
Inherited from: Registry
Get a specific resource in the registry, and resolve all of its relationships to other assets, participants, and transactions. The result is a JavaScript object, and should only be used for visualization purposes. You cannot use the add or update functions with a resolved resource.
Returns
Promise - A promise that will be resolved with a JavaScript object representing the resource and all of its resolved relationships.
See also
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the asset. |