Overview - Common API - Client API - Admin API - Runtime API
IdentityRegistry
The IdentityRegistry is used to store a set of identities on the blockchain.
Details
Extends Registry
Module client
See also
- See Registry
Method Summary
| Name | Returns | Description |
|---|---|---|
| add | void |
Unsupported operation; you cannot add an identity to an identity registry |
| addAll | void |
Unsupported operation; you cannot add an identity to an identity registry |
| getIdentityRegistry | Promise |
Get an existing identity registry |
| remove | void |
Unsupported operation; you cannot remove an identity from an identity registry |
| removeAll | void |
Unsupported operation; you cannot remove an identity from an identity registry |
| update | void |
Unsupported operation; you cannot update an identity in an identity registry |
| updateAll | void |
Unsupported operation; you cannot update an identity in an identity registry |
Inherited Method Summary
| Supertype | Name | Returns | Description |
|---|---|---|---|
| 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
getIdentityRegistry
Promise getIdentityRegistry( SecurityContext securitycontext, ModelManager modelmanager, Factory factory, Serializer serializer )
Get an existing identity registry.
Returns
Promise - A promise that will be resolved with a IdentityRegistry instance representing the identity registry.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| securityContext | SecurityContext | Yes | The user's security context. |
| modelManager | ModelManager | Yes | The ModelManager to use for this identity registry. |
| factory | Factory | Yes | The factory to use for this identity registry. |
| serializer | Serializer | Yes | The Serializer to use for this identity registry. |
add
add( Resource resource, string data )
Unsupported operation; you cannot add an identity to an identity registry.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be added to the registry. |
| data | string | Yes | The data for the resource. |
addAll
addAll( resources )
Unsupported operation; you cannot add an identity to an identity registry.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be added to the registry. |
update
update( Resource resource )
Unsupported operation; you cannot update an identity in an identity registry. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource | Yes | The resource to be updated in the registry. |
updateAll
updateAll( resources )
Unsupported operation; you cannot update an identity in an identity registry.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Yes | The resources to be updated in the asset registry. |
remove
remove( Resource; string resource )
Unsupported operation; you cannot remove an identity from an identity registry. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resource | Resource; string | Yes | The resource, or the unique identifier of the resource. |
removeAll
removeAll( Resource[]; string[] resources )
Unsupported operation; you cannot remove an identity from an identity registry. This method will always throw an exception when called.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| resources | Resource[]; string[] | Yes | The resources, or the unique identifiers of the resources. |
Inherited methods
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.
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.
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.
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.
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.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| id | string | Yes | The unique identifier of the asset. |