Registry (Client API)

Overview - Common API - Client API - Admin API - Runtime API

Registry

Class representing an Abstract Registry.

** Applications should retrieve instances from BusinessNetworkConnection**

Details

  • Module client

Method Summary

Name Returns Description
add Promise Adds a new resource to the registry
addAll Promise Adds a list of new resources to the registry
exists Promise Determines whether a specific resource exists in the registry
get Promise Get a specific resource in the registry
getAll Promise Get all of the resources in the registry
remove Promise Remove an asset with a given type and id from the registry
removeAll Promise Removes a list of resources from the registry
resolve Promise Get a specific resource in the registry, and resolve all of its relationships to other assets, participants, and transactions
resolveAll Promise Get all of the resources in the registry, and resolve all of their relationships to other assets, participants, and transactions
update Promise Updates a resource in the registry
updateAll Promise Updates a list of resources in the registry

Method Details

addAll

Promise addAll( resources )

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.

Parameters

Name Type Mandatory Description
resources Yes The resources to be added to the registry.

add

Promise add( Resource resource )

Adds a new resource to the registry.

Returns

Promise - A promise that will be resolved when the resource is added to the registry.

Parameters

Name Type Mandatory Description
resource Resource Yes The resource to be added to the registry.

updateAll

Promise updateAll( resources )

Updates a list of resources in the registry.

Returns

Promise - A promise that will be resolved when the resource is added to the registry.

Parameters

Name Type Mandatory Description
resources Yes The resources to be updated in the asset registry.

update

Promise update( Resource resource )

Updates a resource in the registry.

Returns

Promise - A promise that will be resolved when the resource is updated in the registry.

Parameters

Name Type Mandatory Description
resource Resource Yes The resource to be updated in the registry.

removeAll

Promise removeAll( Resource[]; string[] resources )

Removes a list of resources from the registry.

Returns

Promise - A promise that will be resolved when the resource is added to the registry.

Parameters

Name Type Mandatory Description
resources Resource[]; string[] Yes The resources, or the unique identifiers of the resources.

remove

Promise remove( Resource; string resource )

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.

Parameters

Name Type Mandatory Description
resource Resource; string Yes The resource, or the unique identifier of the resource.

getAll

Promise getAll( )

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.

Parameters

No parameters

get

Promise get( string id )

Get a specific resource in the registry.

Returns

Promise - A promise that will be resolved with a JSON object representing the resource.

Parameters

Name Type Mandatory Description
id string Yes The unique identifier of the resource.

exists

Promise exists( string id )

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.

Parameters

Name Type Mandatory Description
id string Yes The unique identifier of the resource.

resolveAll

Promise resolveAll( )

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.

Parameters

No parameters

resolve

Promise resolve( string id )

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.

Parameters

Name Type Mandatory Description
id string Yes The unique identifier of the asset.

Inherited methods