Class: MetadataEntry
api/entities/MetadataEntry.MetadataEntry
Represents an Asset MetadataEntry in the Polymesh blockchain
Hierarchy
-
Entity<UniqueIdentifiers,HumanReadable>↳
MetadataEntry
Properties
asset
• asset: BaseAsset
Asset for which this is the metadata
Defined in
api/entities/MetadataEntry/index.ts:37
id
• id: BigNumber
identifier number of the MetadataEntry
Defined in
api/entities/MetadataEntry/index.ts:47
type
• type: MetadataType
Type of metadata represented by this instance
Defined in
api/entities/MetadataEntry/index.ts:42
uuid
• uuid: string
Inherited from
Defined in
Methods
details
▸ details(): Promise<MetadataDetails>
Retrieve name and specs for this MetadataEntry
Returns
Promise<MetadataDetails>
Defined in
api/entities/MetadataEntry/index.ts:92
exists
▸ exists(): Promise<boolean>
Determine whether this MetadataEntry exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/MetadataEntry/index.ts:168
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
entity | Entity<unknown, unknown> |
Returns
boolean
Inherited from
Defined in
set
▸ set(args, opts?): Promise<GenericPolymeshTransaction<MetadataEntry, MetadataEntry>>
Assign new value for the MetadataEntry along with its details or optionally only set the details (expiry + lock status) of any Metadata value
Parameters
| Name | Type |
|---|---|
args | SetMetadataParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<MetadataEntry, MetadataEntry>>
Note
- Value or the details can only be set if the MetadataEntry is not locked
Note
this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/MetadataEntry/index.ts:85
toHuman
▸ toHuman(): HumanReadable
Return the MetadataEntry's ID, Asset ticker and Metadata type
Returns
Overrides
Defined in
api/entities/MetadataEntry/index.ts:175
value
▸ value(): Promise<null | MetadataValue>
Retrieve the value and details (expiry + lock status) for this MetadataEntry
Returns
Promise<null | MetadataValue>
Note
- This returns
nullif no value is yet specified for this MetadataEntry
Defined in
api/entities/MetadataEntry/index.ts:139
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type |
|---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type | Description |
|---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers