Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • uuid
  • Methods
  • Abstract exists
  • isEqual
  • Abstract toHuman
  • Static generateUuid
  • Static isUniqueIdentifiers
  • Static unserialize

Was this helpful?

  1. Classes

Entity

PreviousDocumentsNextIdentities

Last updated 2 years ago

Was this helpful?

Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality

Type parameters

▪ UniqueIdentifiers

▪ HumanReadable

Hierarchy

  • Entity

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

    ↳

Index

Properties

Methods

Properties

Protected context

• context: Context


uuid

• uuid: string

Methods

Abstract exists

▸ exists(): Promise‹boolean›

Determine whether this Entity exists on chain

Returns: Promise‹boolean›


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


Abstract toHuman

▸ toHuman(): HumanReadable

Returns Entity data in a human readable (JSON) format

Returns: HumanReadable


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static isUniqueIdentifiers

▸ isUniqueIdentifiers(identifiers: unknown): boolean

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters:

Name
Type
Description

identifiers

unknown

object to type check

Returns: boolean


Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Defined in

Defined in

Defined in

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

Defined in

‹unknown, unknown›

Defined in

Defined in

Defined in

Defined in

CheckpointSchedule
CorporateActionBase
Identity
Account
TickerReservation
Asset
AuthorizationRequest
Offering
Venue
Instruction
Portfolio
Checkpoint
PermissionGroup
Subsidy
src/api/entities/Entity.ts:48
src/api/entities/Entity.ts:46
src/api/entities/Entity.ts:68
Entity
src/api/entities/Entity.ts:61
src/api/entities/Entity.ts:73
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:42
src/api/entities/Entity.ts:23
context
uuid
exists
isEqual
toHuman
generateUuid
isUniqueIdentifiers
unserialize
Entity