api_entities_DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer

@polymeshassociation/polymesh-sdk / Modules / api/entities/DefaultTrustedClaimIssuer / DefaultTrustedClaimIssuer

Class: DefaultTrustedClaimIssuer

api/entities/DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer

Represents a default trusted claim issuer for a specific Asset in the Polymesh blockchain

Hierarchy

Table of contents

Properties

Methods

Properties

asset

asset: Asset

Asset for which this Identity is a Default Trusted Claim Issuer

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:36


assetPermissions

assetPermissions: AssetPermissions

Inherited from

Identity.assetPermissions

Defined in

api/entities/Identity/index.ts:99


authorizations

authorizations: IdentityAuthorizations

Inherited from

Identity.authorizations

Defined in

api/entities/Identity/index.ts:97


did

did: string

Identity ID as stored in the blockchain

Inherited from

Identity.did

Defined in

api/entities/Identity/index.ts:94


portfolios

portfolios: Portfolios

Inherited from

Identity.portfolios

Defined in

api/entities/Identity/index.ts:98


uuid

uuid: string

Inherited from

Identity.uuid

Defined in

api/entities/Entity.ts:46

Methods

addedAt

addedAt(): Promise<null | EventIdentifier>

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the trusted claim issuer was added

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Returns

Promise<null | EventIdentifier>

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:55


areSecondaryAccountsFrozen

areSecondaryAccountsFrozen(): Promise<boolean>

Check whether secondary Accounts are frozen

note can be subscribed to

Returns

Promise<boolean>

Inherited from

Identity.areSecondaryAccountsFrozen

Defined in

api/entities/Identity/index.ts:594

areSecondaryAccountsFrozen(callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Inherited from

Identity.areSecondaryAccountsFrozen

Defined in

api/entities/Identity/index.ts:595


checkRoles

checkRoles(roles): Promise<CheckRolesResult>

Check whether this Identity possesses all specified roles

Parameters

Returns

Promise<CheckRolesResult>

Inherited from

Identity.checkRoles

Defined in

api/entities/Identity/index.ts:362


exists

exists(): Promise<boolean>

Determine whether this Identity exists on chain

note asset Identities aren't considered to exist for the

Returns

Promise<boolean>

Inherited from

Identity.exists

Defined in

api/entities/Identity/index.ts:751


getAssetBalance

getAssetBalance(args): Promise<BigNumber>

Retrieve the balance of a particular Asset

note can be subscribed to

Parameters

Returns

Promise<BigNumber>

Inherited from

Identity.getAssetBalance

Defined in

api/entities/Identity/index.ts:166

getAssetBalance(args, callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Inherited from

Identity.getAssetBalance

Defined in

api/entities/Identity/index.ts:167


getHeldAssets

getHeldAssets(opts?): Promise<ResultSet<Asset>>

Retrieve a list of all Assets which were held at one point by this Identity

note uses the middleware

note supports pagination

Parameters

Returns

Promise<ResultSet<Asset>>

Inherited from

Identity.getHeldAssets

Defined in

api/entities/Identity/index.ts:320


getInstructions

getInstructions(): Promise<GroupedInstructions>

Retrieve all Instructions where this Identity is a participant, grouped by status

Returns

Promise<GroupedInstructions>

Inherited from

Identity.getInstructions

Defined in

api/entities/Identity/index.ts:472


getPendingDistributions

getPendingDistributions(): Promise<DistributionWithDetails[]>

Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid

note uses the middleware

note this query can be potentially SLOW depending on which Assets this Identity has held

Returns

Promise<DistributionWithDetails[]>

Inherited from

Identity.getPendingDistributions

Defined in

api/entities/Identity/index.ts:631


getPendingInstructions

getPendingInstructions(): Promise<Instruction[]>

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns

Promise<Instruction[]>

Inherited from

Identity.getPendingInstructions

Defined in

api/entities/Identity/index.ts:541


getPrimaryAccount

getPrimaryAccount(): Promise<PermissionedAccount>

Retrieve the primary Account associated with the Identity

note can be subscribed to

Returns

Promise<PermissionedAccount>

Inherited from

Identity.getPrimaryAccount

Defined in

api/entities/Identity/index.ts:267

getPrimaryAccount(callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Inherited from

Identity.getPrimaryAccount

Defined in

api/entities/Identity/index.ts:268


getScopeId

getScopeId(args): Promise<null | string>

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Asset, or null if there is none

note more on Investor Uniqueness here and here

Parameters

Returns

Promise<null | string>

Inherited from

Identity.getScopeId

Defined in

api/entities/Identity/index.ts:450


getSecondaryAccounts

getSecondaryAccounts(): Promise<PermissionedAccount[]>

Get the list of secondary Accounts related to the Identity

note can be subscribed to

note This method currently lacks pagination and may be slow for identities with many thousands of keys

Returns

Promise<PermissionedAccount[]>

Inherited from

Identity.getSecondaryAccounts

Defined in

api/entities/Identity/index.ts:686

getSecondaryAccounts(callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Inherited from

Identity.getSecondaryAccounts

Defined in

api/entities/Identity/index.ts:687


getTrustingAssets

getTrustingAssets(): Promise<Asset[]>

Get the list of Assets for which this Identity is a trusted claim issuer

note uses the middleware

Returns

Promise<Asset[]>

Inherited from

Identity.getTrustingAssets

Defined in

api/entities/Identity/index.ts:397


getVenues

getVenues(): Promise<Venue[]>

Retrieve all Venues created by this Identity

note can be subscribed to

Returns

Promise<Venue[]>

Inherited from

Identity.getVenues

Defined in

api/entities/Identity/index.ts:414

getVenues(callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Inherited from

Identity.getVenues

Defined in

api/entities/Identity/index.ts:415


hasRole

hasRole(role): Promise<boolean>

Check whether this Identity possesses the specified Role

Parameters

Returns

Promise<boolean>

Inherited from

Identity.hasRole

Defined in

api/entities/Identity/index.ts:118


hasRoles

hasRoles(roles): Promise<boolean>

Check whether this Identity possesses all specified roles

deprecated in favor of checkRoles

Parameters

Returns

Promise<boolean>

Inherited from

Identity.hasRoles

Defined in

api/entities/Identity/index.ts:386


hasValidCdd

hasValidCdd(): Promise<boolean>

Check whether this Identity has a valid CDD claim

Returns

Promise<boolean>

Inherited from

Identity.hasValidCdd

Defined in

api/entities/Identity/index.ts:215


isCddProvider

isCddProvider(): Promise<boolean>

Check whether this Identity is a CDD provider

Returns

Promise<boolean>

Inherited from

Identity.isCddProvider

Defined in

api/entities/Identity/index.ts:248


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Returns

boolean

Inherited from

Identity.isEqual

Defined in

api/entities/Entity.ts:61


isGcMember

isGcMember(): Promise<boolean>

Check whether this Identity is Governance Committee member

Returns

Promise<boolean>

Inherited from

Identity.isGcMember

Defined in

api/entities/Identity/index.ts:231


toHuman

toHuman(): string

Return the Identity's DID

Returns

string

Inherited from

Identity.toHuman

Defined in

api/entities/Identity/index.ts:774


trustedFor

trustedFor(): Promise<null | ClaimType[]>

Retrieve claim types for which this Claim Issuer is trusted. A null value means that the issuer is trusted for all claim types

Returns

Promise<null | ClaimType[]>

Defined in

api/entities/DefaultTrustedClaimIssuer.ts:77


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Parameters

Returns

string

Inherited from

Identity.generateUuid

Defined in

api/entities/Entity.ts:14


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Parameters

Returns

Identifiers

Inherited from

Identity.unserialize

Defined in

api/entities/Entity.ts:23

Last updated