Identity
Represents an Identity in the Polymesh blockchain
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Identity(identifiers: UniqueIdentifiers, context: Context): Identity
Overrides void
Defined in src/api/entities/Identity/index.ts:73
Create an Identity entity
Parameters:
Returns: Identity
Properties
authorizations
• authorizations: IdentityAuthorizations
Defined in src/api/entities/Identity/index.ts:72
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
did
• did: string
Defined in src/api/entities/Identity/index.ts:69
identity ID as stored in the blockchain
portfolios
• portfolios: Portfolios
Defined in src/api/entities/Identity/index.ts:73
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
Defined in src/api/entities/Identity/index.ts:287
Retrieve a list of all tokens which were held at one point by this Identity
note supports pagination
Parameters:
▪Default value opts: object= { order: Order.Asc }
Name
Type
order?
Order
size?
undefined | number
start?
undefined | number
Returns: Promise‹ResultSet‹SecurityToken››
getPrimaryKey
▸ getPrimaryKey(): Promise‹string›
Defined in src/api/entities/Identity/index.ts:253
Retrieve the primary key associated with the Identity
note can be subscribed to
Returns: Promise‹string›
▸ getPrimaryKey(callback: SubCallback‹string›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:254
Parameters:
Name
Type
callback
SubCallback‹string›
Returns: Promise‹UnsubCallback›
getTokenBalance
▸ getTokenBalance(args: object): Promise‹BigNumber›
Defined in src/api/entities/Identity/index.ts:152
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›
Defined in src/api/entities/Identity/index.ts:153
Parameters:
▪ args: object
Name
Type
ticker
string
▪ callback: SubCallback‹BigNumber›
Returns: Promise‹UnsubCallback›
getTrustingTokens
▸ getTrustingTokens(args: object): Promise‹SecurityToken[]›
Defined in src/api/entities/Identity/index.ts:338
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[]›
Defined in src/api/entities/Identity/index.ts:359
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›
Defined in src/api/entities/Identity/index.ts:360
Parameters:
Name
Type
callback
SubCallback‹Venue[]›
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:91
Check whether this Identity possesses the specified Role
Parameters:
Name
Type
role
Returns: Promise‹boolean›
hasRoles
▸ hasRoles(roles: Role[]): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:327
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:200
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:234
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isGcMember
▸ isGcMember(): Promise‹boolean›
Defined in src/api/entities/Identity/index.ts:217
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(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: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(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: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated