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