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
Inherited from Identity.constructor
Overrides void
Defined in src/api/entities/Identity/index.ts:73
Create an Identity entity
Parameters:
Returns: CurrentIdentity
Properties
authorizations
• authorizations: IdentityAuthorizations
Inherited from Identity.authorizations
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
Inherited from Identity.portfolios
Defined in src/api/entities/Identity/index.ts:73
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
createVenue
▸ createVenue(args: CreateVenueParams): Promise‹TransactionQueue‹Venue››
Defined in src/api/entities/CurrentIdentity.ts:105
Create a Venue
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹Venue››
getHeldTokens
▸ getHeldTokens(opts: object): Promise‹ResultSet‹SecurityToken››
Inherited from Identity.getHeldTokens
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››
getPendingInstructions
▸ getPendingInstructions(): Promise‹Instruction[]›
Defined in src/api/entities/CurrentIdentity.ts:112
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:253
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:254
Parameters:
Name
Type
callback
SubCallback‹string›
Returns: Promise‹UnsubCallback›
getSecondaryKeys
▸ getSecondaryKeys(): Promise‹SecondaryKey[]›
Defined in src/api/entities/CurrentIdentity.ts:37
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:38
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: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›
Inherited from Identity.getTokenBalance
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[]›
Inherited from Identity.getTrustingTokens
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[]›
Inherited from Identity.getVenues
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›
Inherited from Identity.getVenues
Defined in src/api/entities/Identity/index.ts:360
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:91
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:327
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:200
Check whether this Identity has a valid CDD claim
Returns: Promise‹boolean›
inviteAccount
▸ inviteAccount(args: InviteAccountParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CurrentIdentity.ts:98
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
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹void››
isCddProvider
▸ isCddProvider(): Promise‹boolean›
Inherited from Identity.isCddProvider
Defined in src/api/entities/Identity/index.ts:234
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:217
Check whether this Identity is Governance Committee member
Returns: Promise‹boolean›
modifyPermissions
▸ modifyPermissions(args: ModifySignerPermissionsParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CurrentIdentity.ts:82
Modify all permissions of a list of secondary keys associated with the Identity
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹void››
removeSecondaryKeys
▸ removeSecondaryKeys(args: RemoveSecondaryKeysParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CurrentIdentity.ts:56
Remove a list of secondary keys associated with the Identity
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹void››
revokePermissions
▸ revokePermissions(args: object): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CurrentIdentity.ts:63
Revoke all permissions of a list of secondary keys associated with the Identity
Parameters:
▪ args: object
Name
Type
secondaryKeys
Signer[]
Returns: Promise‹TransactionQueue‹void››
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