Class: Requirements
api/entities/Asset/Base/Compliance/Requirements.Requirements
Handles all Asset Compliance Requirements related functionality
Hierarchy
-
Namespace<BaseAsset>↳
Requirements
Methods
add
▸ add(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Add a new compliance requirement to the the Asset. This doesn't modify existing requirements
Parameters
| Name | Type |
|---|---|
args | AddAssetRequirementParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call add.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:94
arePaused
▸ arePaused(): Promise<boolean>
Check whether Asset compliance requirements are paused or not
Returns
Promise<boolean>
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:221
get
▸ get(): Promise<ComplianceRequirements>
Retrieve all of the Asset's compliance requirements, together with the Default Trusted Claim Issuers
Returns
Promise<ComplianceRequirements>
Note
can be subscribed to, if connected to node using a web socket
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:126
▸ get(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<ComplianceRequirements> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:127
modify
▸ modify(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Modify a compliance requirement for the Asset
Parameters
| Name | Type |
|---|---|
args | ModifyComplianceRequirementParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:245
pause
▸ pause(opts?): Promise<GenericPolymeshTransaction<void, void>>
Pause all the Asset's requirements. This means that all transfers will be allowed until requirements are unpaused
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type NoArgsProcedureMethod, which means you can call pause.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:204
remove
▸ remove(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Remove an existing compliance requirement from the Asset
Parameters
| Name | Type |
|---|---|
args | RemoveAssetRequirementParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:104
reset
▸ reset(opts?): Promise<GenericPolymeshTransaction<void, void>>
Delete all the current requirements for the Asset.
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type NoArgsProcedureMethod, which means you can call reset.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:194
set
▸ set(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Configure compliance requirements for the Asset. This operation will replace all existing requirements with a new requirement set
Parameters
| Name | Type |
|---|---|
args | SetAssetRequirementsParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Example
Say A, B, C, D and E are requirements and we arrange them as `[[A, B], [C, D], [E]]`.
For a transfer to succeed, it must either comply with A AND B, C AND D, OR E.
Note
this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Base/Compliance/Requirements.ts:117
unpause
▸ unpause(opts?): Promise<GenericPolymeshTransaction<void, void>>
Un-pause all the Asset's current requirements
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type NoArgsProcedureMethod, which means you can call unpause.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it