@polymeshassociation/polymesh-sdk / api/entities/Asset/Base/Compliance/Requirements

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:39

Handles all Asset Compliance Requirements related functionality

• Namespace<BaseAsset>

add(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:88

Add a new compliance requirement to the the Asset. This doesn't modify existing requirements

Promise<GenericPolymeshTransaction<void, void>>

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

arePaused(): Promise<boolean>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:197

Check whether Asset compliance requirements are paused or not

Promise<boolean>

get(): Promise<ComplianceRequirements>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:108

Retrieve all of the Asset's compliance requirements, together with the Default Trusted Claim Issuers

Promise<ComplianceRequirements>

Promise that resolves to the compliance requirements and trusted claim issuers

get(callback): Promise<UnsubCallback>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:118

Retrieve all of the Asset's compliance requirements, together with the Default Trusted Claim Issuers

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

modify(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:218

Modify a compliance requirement for the Asset

Promise<GenericPolymeshTransaction<void, void>>

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

pause(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:187

Pause all the Asset's requirements. This means that all transfers will be allowed until requirements are unpaused

Promise<GenericPolymeshTransaction<void, void>>

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

remove(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:93

Remove an existing compliance requirement from the Asset

Promise<GenericPolymeshTransaction<void, void>>

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

reset(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:182

Delete all the current requirements for the Asset.

Promise<GenericPolymeshTransaction<void, void>>

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

set(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:101

Configure compliance requirements for the Asset. This operation will replace all existing requirements with a new requirement set

Promise<GenericPolymeshTransaction<void, void>>

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.

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

unpause(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/Compliance/Requirements.ts:192

Un-pause all the Asset's current requirements

Promise<GenericPolymeshTransaction<void, void>>

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