api/entities/MetadataEntry.MetadataEntry

Represents an Asset MetadataEntry in the Polymesh blockchain

• Entity<UniqueIdentifiers, HumanReadable>

  ↳ MetadataEntry

• asset
• id
• type
• uuid

• clear
• details
• exists
• isEqual
• isModifiable
• remove
• set
• toHuman
• value
• generateUuid
• unserialize

• asset: BaseAsset

Asset for which this is the metadata

api/entities/MetadataEntry/index.ts:46

---

• id: BigNumber

identifier number of the MetadataEntry

api/entities/MetadataEntry/index.ts:56

---

• type: MetadataType

Type of metadata represented by this instance

api/entities/MetadataEntry/index.ts:51

---

• uuid: string

Entity.uuid

api/entities/Entity.ts:46

▸ clear(opts?): Promise<GenericPolymeshTransaction<void, void>>

Removes the asset metadata value

Name	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Throws

• if the Metadata doesn't exists
  • if the Metadata value is locked

Note

this method is of type NoArgsProcedureMethod, which means you can call clear.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

api/entities/MetadataEntry/index.ts:116

---

▸ details(): Promise<MetadataDetails>

Retrieve name and specs for this MetadataEntry

Promise<MetadataDetails>

api/entities/MetadataEntry/index.ts:141

---

▸ exists(): Promise<boolean>

Determine whether this MetadataEntry exists on chain

Promise<boolean>

Entity.exists

api/entities/MetadataEntry/index.ts:217

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

api/entities/Entity.ts:61

---

▸ isModifiable(): Promise<{ canModify: boolean ; reason?: PolymeshError }>

Check if the MetadataEntry can be modified. A MetadataEntry is modifiable if it exists and is not locked

Promise<{ canModify: boolean ; reason?: PolymeshError }>

api/entities/MetadataEntry/index.ts:250

---

▸ remove(opts?): Promise<GenericPolymeshTransaction<void, void>>

Removes a local Asset Metadata key along with its value

Name	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Note

A global Metadata key cannot be deleted

Throws

• if the Metadata type is global
  • if the Metadata doesn't exists
  • if the Metadata value is locked
  • if the Metadata is a mandatory key for any NFT Collection

Note

this method is of type NoArgsProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

api/entities/MetadataEntry/index.ts:134

---

▸ 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

Name	Type
args	SetMetadataParams
opts?	ProcedureOpts

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

api/entities/MetadataEntry/index.ts:102

---

▸ toHuman(): HumanReadable

Return the MetadataEntry's ID, Asset ticker and Metadata type

HumanReadable

Entity.toHuman

api/entities/MetadataEntry/index.ts:313

---

▸ value(): Promise<null | MetadataValue>

Retrieve the value and details (expiry + lock status) for this MetadataEntry

Promise<null | MetadataValue>

Note

• This returns null if no value is yet specified for this MetadataEntry

api/entities/MetadataEntry/index.ts:188

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Entity.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

api/entities/Entity.ts:23