CurrentIdentity
Represents the Identity associated to the current Account
Hierarchy
↳ Identity
↳ CurrentIdentity
Index
Constructors
Properties
Methods
Constructors
constructor
+ new CurrentIdentity(identifiers: UniqueIdentifiers, context: Context): CurrentIdentity
Overrides Identity.constructor
Defined in src/api/entities/CurrentIdentity.ts:34
Create a CurrentIdentity entity
Parameters:
Returns: CurrentIdentity
Properties
authorizations
• authorizations: IdentityAuthorizations
Inherited from Identity.authorizations
Defined in src/api/entities/Identity/index.ts:73
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
createVenue
• createVenue: ProcedureMethod‹CreateVenueParams, Venue›
Defined in src/api/entities/CurrentIdentity.ts:122
Create a Venue
did
• did: string
Defined in src/api/entities/Identity/index.ts:70
identity ID as stored in the blockchain
inviteAccount
• inviteAccount: ProcedureMethod‹InviteAccountParams, void›
Defined in src/api/entities/CurrentIdentity.ts:117
Send an invitation to an Account to join this Identity
note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
param list of allowed permissions (optional, defaults to no permissions)
param array of Security Tokens (or tickers) for which to allow permission. Set null to allow all (optional, no permissions if not passed)
param array of tags associated with the transaction that will be executed for which to allow permission. Set null to allow all (optional, no permissions if not passed)
param array of portfolios for which to allow permission. Set null to allow all (optional, no permissions if not passed)
modifyPermissions
• modifyPermissions: ProcedureMethod‹ModifySignerPermissionsParams, void›
Defined in src/api/entities/CurrentIdentity.ts:103
Modify all permissions of a list of secondary keys associated with the Identity
param list of permissions
param array of Security Tokens on which to grant permissions. A null value represents full permissions
param array of transaction tags that the Secondary Key has permission to execute. A null value represents full permissions
param array of Portfolios for which to grant permissions. A null value represents full permissions
portfolios
• portfolios: Portfolios
Inherited from Identity.portfolios
Defined in src/api/entities/Identity/index.ts:74
removeSecondaryKeys
• removeSecondaryKeys: ProcedureMethod‹RemoveSecondaryKeysParams, void›
Defined in src/api/entities/CurrentIdentity.ts:88
Remove a list of secondary keys associated with the Identity
revokePermissions
• revokePermissions: ProcedureMethod‹object, void›
Defined in src/api/entities/CurrentIdentity.ts:93
Revoke all permissions of a list of secondary keys associated with the Identity
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
Inherited from Identity.getHeldTokens
Defined in src/api/entities/Identity/index.ts:290
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‹ResultSet‹SecurityToken››
getPendingInstructions
▸ getPendingInstructions(): Promise‹Instruction[]›
Defined in src/api/entities/CurrentIdentity.ts:127
Retrieve all pending Instructions involving the Current Identity
Returns: Promise‹Instruction[]›
getPrimaryKey
▸ getPrimaryKey(): Promise‹string›
Inherited from Identity.getPrimaryKey
Defined in src/api/entities/Identity/index.ts:255
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:256
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:396
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[]›
Defined in src/api/entities/CurrentIdentity.ts:69
Get the list of secondary keys related to the Identity
note can be subscribed to
Returns: Promise‹SecondaryKey[]›
▸ getSecondaryKeys(callback: SubCallback‹SecondaryKey[]›): Promise‹UnsubCallback›
Defined in src/api/entities/CurrentIdentity.ts:70
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:155
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:156
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:341
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:362
Retrieve all Venues created by this Identity
note can be subscribed to
Returns: Promise‹Venue[]›
▸ getVenues(callback: SubCallback‹Venue[]›): Promise‹UnsubCallback›
Inherited from Identity.getVenues
Defined in src/api/entities/Identity/index.ts:363
Parameters:
Name
Type
callback
SubCallback‹Venue[]›
Returns: Promise‹UnsubCallback›
hasRole
▸ hasRole(role: Role): Promise‹boolean›
Inherited from Identity.hasRole
Defined in src/api/entities/Identity/index.ts:92
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:330
Check whether this Identity possesses all specified roles
Parameters:
Name
Type
roles
Role[]
Returns: Promise‹boolean›
hasValidCdd
▸ hasValidCdd(): Promise‹boolean›
Inherited from Identity.hasValidCdd
Defined in src/api/entities/Identity/index.ts:203
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:236
Check whether this Identity is a CDD provider
Returns: Promise‹boolean›
isGcMember
▸ isGcMember(): Promise‹boolean›
Inherited from Identity.isGcMember
Defined in src/api/entities/Identity/index.ts:219
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
Was this helpful?