Class: DefaultTrustedClaimIssuer
api/entities/DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer
Represents a default trusted claim issuer for a specific Asset in the Polymesh blockchain
Hierarchy
-
↳
DefaultTrustedClaimIssuer
Properties
asset
• asset: FungibleAsset
Asset for which this Identity is a Default Trusted Claim Issuer
Defined in
api/entities/DefaultTrustedClaimIssuer.ts:35
assetPermissions
• assetPermissions: AssetPermissions
Inherited from
Defined in
api/entities/Identity/index.ts:119
authorizations
• authorizations: IdentityAuthorizations
Inherited from
Defined in
api/entities/Identity/index.ts:117
did
• did: string
Identity ID as stored in the blockchain
Inherited from
Defined in
api/entities/Identity/index.ts:114
portfolios
• portfolios: Portfolios
Inherited from
Defined in
api/entities/Identity/index.ts:118
uuid
• uuid: string
Inherited from
Defined in
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
Returns
Promise
<null
| EventIdentifier
>
Note
uses the middlewareV2
Note
there is a possibility that the data is not ready by the time it is requested. In that case, null
is returned
Defined in
api/entities/DefaultTrustedClaimIssuer.ts:54
areSecondaryAccountsFrozen
▸ areSecondaryAccountsFrozen(): Promise
<boolean
>
Check whether secondary Accounts are frozen
Returns
Promise
<boolean
>
Note
can be subscribed to
Inherited from
Identity.areSecondaryAccountsFrozen
Defined in
api/entities/Identity/index.ts:658
▸ areSecondaryAccountsFrozen(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <boolean > |
Returns
Promise
<UnsubCallback
>
Inherited from
Identity.areSecondaryAccountsFrozen
Defined in
api/entities/Identity/index.ts:659
checkRoles
▸ checkRoles(roles
): Promise
<CheckRolesResult
>
Check whether this Identity possesses all specified roles
Parameters
Name | Type |
---|---|
roles | Role [] |
Returns
Promise
<CheckRolesResult
>
Inherited from
Defined in
api/entities/Identity/index.ts:441
exists
▸ exists(): Promise
<boolean
>
Determine whether this Identity exists on chain
Returns
Promise
<boolean
>
Note
asset Identities aren't considered to exist for this check
Inherited from
Defined in
api/entities/Identity/index.ts:824
getAssetBalance
▸ getAssetBalance(args
): Promise
<BigNumber
>
Retrieve the balance of a particular Asset
Parameters
Name | Type |
---|---|
args | Object |
args.ticker | string |
Returns
Promise
<BigNumber
>
Note
can be subscribed to
Inherited from
Defined in
api/entities/Identity/index.ts:195
▸ getAssetBalance(args
, callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
args | Object |
args.ticker | string |
callback | SubCallback <BigNumber > |
Returns
Promise
<UnsubCallback
>
Inherited from
Defined in
api/entities/Identity/index.ts:196
getChildIdentities
▸ getChildIdentities(): Promise
<ChildIdentity
[]>
Returns the list of all child identities
Returns
Promise
<ChildIdentity
[]>
Note
this query can be potentially SLOW depending on the number of parent Identities present on the chain
Inherited from
Defined in
api/entities/Identity/index.ts:876
getHeldAssets
▸ getHeldAssets(opts?
): Promise
<ResultSet
<FungibleAsset
>>
Retrieve a list of all Assets which were held at one point by this Identity
Parameters
Name | Type |
---|---|
opts | Object |
opts.order? | AssetHoldersOrderBy |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Promise
<ResultSet
<FungibleAsset
>>
Note
uses the middlewareV2
Note
supports pagination
Inherited from
Defined in
api/entities/Identity/index.ts:349
getHeldNfts
▸ getHeldNfts(opts?
): Promise
<ResultSet
<HeldNfts
>>
Retrieve a list of all NftCollections which were held at one point by this Identity
Parameters
Name | Type |
---|---|
opts | Object |
opts.order? | NftHoldersOrderBy |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Note
uses the middlewareV2
Note
supports pagination
Inherited from
Defined in
api/entities/Identity/index.ts:394
getHistoricalInstructions
▸ getHistoricalInstructions(): Promise
<HistoricInstruction
[]>
Retrieve all Instructions that have been associated with this Identity's DID
Returns
Promise
<HistoricInstruction
[]>
Note
uses the middleware V2
Inherited from
Identity.getHistoricalInstructions
Defined in
api/entities/Identity/index.ts:856
getInstructions
▸ getInstructions(): Promise
<GroupedInstructions
>
Retrieve all Instructions where this Identity is a custodian of one or more portfolios in the legs, grouped by status
Returns
Promise
<GroupedInstructions
>
Inherited from
Defined in
api/entities/Identity/index.ts:512
getInvolvedInstructions
▸ getInvolvedInstructions(): Promise
<GroupedInvolvedInstructions
>
Retrieve all Instructions where this Identity is a participant (owner/custodian), grouped by the role of the Identity and Instruction status
Returns
Promise
<GroupedInvolvedInstructions
>
Inherited from
Identity.getInvolvedInstructions
Defined in
api/entities/Identity/index.ts:599
getPendingDistributions
▸ getPendingDistributions(): Promise
<DistributionWithDetails
[]>
Retrieve every Dividend Distribution for which this Identity is eligible and hasn't been paid
Returns
Promise
<DistributionWithDetails
[]>
Note
uses the middleware
Note
this query can be potentially SLOW depending on which Assets this Identity has held
Inherited from
Identity.getPendingDistributions
Defined in
api/entities/Identity/index.ts:695
getPrimaryAccount
▸ getPrimaryAccount(): Promise
<PermissionedAccount
>
Retrieve the primary Account associated with the Identity
Returns
Promise
<PermissionedAccount
>
Note
can be subscribed to
Inherited from
Defined in
api/entities/Identity/index.ts:296
▸ getPrimaryAccount(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <PermissionedAccount > |
Returns
Promise
<UnsubCallback
>
Inherited from
Defined in
api/entities/Identity/index.ts:297
getSecondaryAccounts
▸ getSecondaryAccounts(paginationOpts?
): Promise
<ResultSet
<PermissionedAccount
>>
Get the list of secondary Accounts related to the Identity
Parameters
Name | Type |
---|---|
paginationOpts? | PaginationOptions |
Returns
Promise
<ResultSet
<PermissionedAccount
>>
Note
supports pagination
Note
can be subscribed to
Inherited from
Defined in
api/entities/Identity/index.ts:750
▸ getSecondaryAccounts(callback
): Promise
<UnsubCallback
>
Parameters
Name | Type |
---|---|
callback | SubCallback <PermissionedAccount []> |
Returns
Promise
<UnsubCallback
>
Inherited from
Defined in
api/entities/Identity/index.ts:754
▸ getSecondaryAccounts(paginationOpts
, callback
): Promise
<UnsubCallback
>