Class Ipns

Hierarchy (view full)

Constructors

constructor

Properties

name description ipnsName ipnsValue link bucketUuid API_PREFIX uuid createTime updateTime

Methods

get publish delete populate serialize serializeFilter

Constructors

constructor

  • new Ipns(bucketUuid, ipnsUuid, data?): Ipns

  • Constructor which should only be called via StorageBucket class.

    Parameters

    • bucketUuid: string

      Unique identifier of the file's bucket.

    • ipnsUuid: string

      Unique identifier of the IPNS record.

    • Optional data: Partial<Ipns>

      Data to populate the IPNS record with.

    Returns Ipns

Properties

name

name: string = null

Informational IPNS name, which is set by user to easily organize their IPNS records.

description

description: string = null

IPNS record description.

ipnsName

ipnsName: string = null

IPNS name that is used to access IPNS content on IPFS gateway.

ipnsValue

ipnsValue: string = null

IPFS value (CID), to which this IPNS points.

link

link: string = null

IPNS link to Apillon IPFS gateway, where it is possible to see content to which this IPNS points.

bucketUuid

bucketUuid: string = null

Unique identifier of the IPNS record's bucket.

Protected API_PREFIX

API_PREFIX: string = null

API url prefix for this class.

uuid

uuid: string

Unique identifier of the model.

createTime

createTime: string = null

The object's creation date

updateTime

updateTime: string = null

The date when the object was last updated

Methods

get

publish

  • publish(cid): Promise<Ipns>

  • Publish an IPNS record to IPFS and link it to a CID.

    Parameters

    • cid: string

      CID to which this ipns name will point.

    Returns Promise<Ipns>

    IPNS record with updated data after publish

delete

Protected populate

serialize

Protected serializeFilter

Settings

Member Visibility

Theme

On This Page

constructornamedescriptionipnsNameipnsValuelinkbucketUuidAPI_PREFIXuuidcreateTimeupdateTimegetpublishdeletepopulateserializeserializeFilter