api.entities.Asset.Base.Compliance.TrustedClaimIssuers - PolymeshAssociation/polymesh-sdk GitHub Wiki

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

api/entities/Asset/Base/Compliance/TrustedClaimIssuers

Classes

TrustedClaimIssuers

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:26

Handles all Asset Default Trusted Claim Issuers related functionality

Extends

Methods

add()

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

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:84

Add the supplied Identities to the Asset's list of trusted claim issuers

Parameters
Parameter Type
args ModifyAssetTrustedClaimIssuersAddSetParams
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

get()
Call Signature

get(): Promise<TrustedClaimIssuer<true>[]>

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:96

Retrieve the current Default Trusted Claim Issuers of the Asset

Returns

Promise<TrustedClaimIssuer<true>[]>

Promise that resolves to the list of default trusted claim issuers

Call Signature

get(callback): Promise<UnsubCallback>

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:106

Retrieve the current Default Trusted Claim Issuers of the Asset

Parameters
Parameter Type Description
callback SubCallback<TrustedClaimIssuer<true>[]> Callback function that receives trusted claim issuers updates
Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

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

remove()

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

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:89

Remove the supplied Identities from the Asset's list of trusted claim issuers *

Parameters
Parameter Type
args ModifyAssetTrustedClaimIssuersRemoveParams
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

set()

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

Defined in: api/entities/Asset/Base/Compliance/TrustedClaimIssuers.ts:79

Assign a new default list of trusted claim issuers to the Asset by replacing the existing ones with the list passed as a parameter

This requires two transactions

Parameters
Parameter Type
args ModifyAssetTrustedClaimIssuersAddSetParams
opts? ProcedureOpts
Returns

Promise<GenericPolymeshTransaction<void, void>>

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

⚠️ **GitHub.com Fallback** ⚠️