Agent

Represents an agent for a Security Token

Hierarchy

Identity

Agent

Index

Properties

Methods

Properties

authorizations

authorizations: IdentityAuthorizations

Inherited from Identity.authorizations

Defined in src/api/entities/Identity/index.ts:98

Protected context

context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

did

did: string

Inherited from Identity.did

Defined in src/api/entities/Identity/index.ts:95

identity ID as stored in the blockchain

portfolios

portfolios: Portfolios

Inherited from Identity.portfolios

Defined in src/api/entities/Identity/index.ts:99

ticker

ticker: string

Defined in src/api/entities/Agent.ts:25

ticker of the Security Token

uuid

uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

areSecondaryKeysFrozen

areSecondaryKeysFrozen(): Promise‹boolean›

Inherited from Identity.areSecondaryKeysFrozen

Defined in src/api/entities/Identity/index.ts:693

Check whether secondary keys are frozen

note can be subscribed to

Returns: Promise‹boolean›

areSecondaryKeysFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback

Inherited from Identity.areSecondaryKeysFrozen

Defined in src/api/entities/Identity/index.ts:694

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

getHeldTokens

getHeldTokens(opts: object): Promise‹ResultSetSecurityToken››

Inherited from Identity.getHeldTokens

Defined in src/api/entities/Identity/index.ts:445

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

note uses the middleware

note supports pagination

Parameters:

Default value opts: object= { order: Order.Asc }

Name

Type

order?

Order

size?

undefined | number

start?

undefined | number

Returns: Promise‹ResultSetSecurityToken››

getInstructions

getInstructions(): Promise‹GroupedInstructions

Inherited from Identity.getInstructions

Defined in src/api/entities/Identity/index.ts:569

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

Returns: Promise‹GroupedInstructions

getPendingDistributions

getPendingDistributions(): Promise‹DistributionWithDetails[]›

Inherited from Identity.getPendingDistributions

Defined in src/api/entities/Identity/index.ts:729

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 Tokens this Identity has held

Returns: Promise‹DistributionWithDetails[]›

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›

Inherited from Identity.getPendingInstructions

Defined in src/api/entities/Identity/index.ts:642

Retrieve all pending Instructions involving this Identity

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

getPrimaryKey

getPrimaryKey(): Promise‹string›

Inherited from Identity.getPrimaryKey

Defined in src/api/entities/Identity/index.ts:410

Retrieve the primary key associated with the Identity

note can be subscribed to

Returns: Promise‹string›

getPrimaryKey(callback: SubCallback‹string›): Promise‹UnsubCallback

Inherited from Identity.getPrimaryKey

Defined in src/api/entities/Identity/index.ts:411

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

getScopeId

getScopeId(args: object): Promise‹string›

Inherited from Identity.getScopeId

Defined in src/api/entities/Identity/index.ts:551

Retrieve the Scope ID associated to this Identity's Investor Uniqueness Claim for a specific Security Token

note more on Investor Uniqueness: https://developers.polymesh.live/confidential_identity

Parameters:

args: object

Name

Type

token

SecurityToken | string

Returns: Promise‹string›

getSecondaryKeys

getSecondaryKeys(): Promise‹SecondaryKey[]›

Inherited from Identity.getSecondaryKeys

Defined in src/api/entities/Identity/index.ts:781

Get the list of secondary keys related to the Identity

note can be subscribed to

Returns: Promise‹SecondaryKey[]›

getSecondaryKeys(callback: SubCallbackSecondaryKey[]›): Promise‹UnsubCallback

Inherited from Identity.getSecondaryKeys

Defined in src/api/entities/Identity/index.ts:782

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

getTokenBalance

getTokenBalance(args: object): Promise‹BigNumber›

Inherited from Identity.getTokenBalance

Defined in src/api/entities/Identity/index.ts:310

Retrieve the balance of a particular Security Token

note can be subscribed to

Parameters:

args: object

Name

Type

ticker

string

Returns: Promise‹BigNumber›

getTokenBalance(args: object, callback: SubCallback‹BigNumber›): Promise‹UnsubCallback

Inherited from Identity.getTokenBalance

Defined in src/api/entities/Identity/index.ts:311

Parameters:

args: object

Name

Type

ticker

string

callback: SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback

getTrustingTokens

getTrustingTokens(args: object): Promise‹SecurityToken[]›

Inherited from Identity.getTrustingTokens

Defined in src/api/entities/Identity/index.ts:496

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

note uses the middleware

Parameters:

Default value args: object= { order: Order.Asc }

Name

Type

order

Order

Returns: Promise‹SecurityToken[]›

getVenues

getVenues(): Promise‹Venue[]›

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:517

Retrieve all Venues created by this Identity

note can be subscribed to

Returns: Promise‹Venue[]›

getVenues(callback: SubCallbackVenue[]›): Promise‹UnsubCallback

Inherited from Identity.getVenues

Defined in src/api/entities/Identity/index.ts:518

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

hasRole

hasRole(role: Role): Promise‹boolean›

Inherited from Identity.hasRole

Defined in src/api/entities/Identity/index.ts:240

Check whether this Identity possesses the specified Role

Parameters:

Name

Type

role

Returns: Promise‹boolean›

hasRoles

hasRoles(roles: Role[]): Promise‹boolean›

Inherited from Identity.hasRoles

Defined in src/api/entities/Identity/index.ts:485

Check whether this Identity possesses all specified roles

Parameters:

Name

Type

roles

Returns: Promise‹boolean›

hasTokenPermissions

hasTokenPermissions(args: object): Promise‹boolean›

Inherited from Identity.hasTokenPermissions

Defined in src/api/entities/Identity/index.ts:117

Check whether this Identity has specific transaction Permissions over a Security Token

Parameters:

args: object

Name

Type

token

SecurityToken | string

transactions

TxTag[] | null

Returns: Promise‹boolean›

hasValidCdd

hasValidCdd(): Promise‹boolean›

Inherited from Identity.hasValidCdd

Defined in src/api/entities/Identity/index.ts:358

Check whether this Identity has a valid CDD claim

Returns: Promise‹boolean›

isCddProvider

isCddProvider(): Promise‹boolean›

Inherited from Identity.isCddProvider

Defined in src/api/entities/Identity/index.ts:391

Check whether this Identity is a CDD provider

Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown, unknown›

Returns: boolean

isGcMember

isGcMember(): Promise‹boolean›

Inherited from Identity.isGcMember

Defined in src/api/entities/Identity/index.ts:374

Check whether this Identity is Governance Committee member

Returns: Promise‹boolean›

toJson

toJson(): string

Inherited from Identity.toJson

Overrides Entity.toJson

Defined in src/api/entities/Identity/index.ts:816

Return the Identity's DID

Returns: string

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated