api_entities_Asset_Compliance_Requirements.Requirements
Previousapi_entities_Asset_Compliance.ComplianceNextapi_entities_Asset_Compliance_TrustedClaimIssuers.TrustedClaimIssuers
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Requirements
.Requirements
Handles all Asset Compliance Requirements related functionality
Namespace<>
↳ Requirements
Add a new compliance requirement to the the Asset. This doesn't modify existing requirements
Parameters
args
opts?
Returns
Defined in
â–¸ arePaused(): Promise<boolean>
Check whether Asset compliance requirements are paused or not
Returns
Promise<boolean>
Defined in
Check whether the sender and receiver Identities in a transfer comply with all the requirements of this Asset
note this does not take balances into account
deprecated in favor of settlements.canTransfer
Parameters
args
Object
-
args.from?
sender Identity (optional, defaults to the signing Identity)
args.to
receiver Identity
Returns
Defined in
Retrieve all of the Asset's compliance requirements, together with the Default Trusted Claim Issuers
note can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
â–¸ modify(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify a compliance requirement for the Asset
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Pause all the Asset's requirements. This means that all transfers will be allowed until requirements are unpaused
Parameters
opts?
Returns
Defined in
Remove an existing compliance requirement from the Asset
Parameters
args
opts?
Returns
Defined in
Delete all the current requirements for the Asset.
Parameters
opts?
Returns
Defined in
Configure compliance requirements for the Asset. This operation will replace all existing requirements with a new requirement set
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.
Parameters
args
opts?
Returns
Defined in
Un-pause all the Asset's current requirements
Parameters
opts?
Returns
Defined in
â–¸ add(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ checkSettle(args): Promise<>
string |
string |
Promise<>
â–¸ get(): Promise<>
Promise<>
â–¸ get(callback): Promise<>
<>
Promise<>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
â–¸ pause(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ remove(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ reset(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ set(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ unpause(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>