Skip to main content

Class: IpfsMetadata

IpfsMetadata

This is part of the ColonyNetwork and ColonyEventManager classes and not to be meant to instantiated directly. You can find an instance of this under colonyNetwork.ipfs or eventManager.ipfs

Constructors​

new IpfsMetadata()​

new IpfsMetadata(adapter?): IpfsMetadata

Parameters​

adapter?​

IpfsAdapter

Returns​

IpfsMetadata

Methods​

getMetadata()​

getMetadata\<K>(cid, type?): Promise\<MetadataTypeMap[K]>

Type Parameters​

• K extends MetadataType

Parameters​

cid​

string

type?​

K

Returns​

Promise\<MetadataTypeMap[K]>

getMetadataForEvent()​

getMetadataForEvent\<T, E>(eventName, cid): Promise\<MetadataTypeMap[T]>

Type Parameters​

• T extends MetadataType

• E extends "" | "Annotation(address,bytes32,string)" | "ColonyMetadata(address,string)" | "DomainMetadata(address,uint256,string)"

Parameters​

eventName​

E

cid​

string

Returns​

Promise\<MetadataTypeMap[T]>

getRawMetadata()​

getRawMetadata(cid): Promise\<Metadata>

Parameters​

cid​

string

Returns​

Promise\<Metadata>

uploadMetadata()​

uploadMetadata\<T>(type, input): Promise\<string>

Type Parameters​

• T extends MetadataType

Parameters​

type​

T

input​

DataTypeMap[T]

Returns​

Promise\<string>

eventSupportsMetadata()​

static eventSupportsMetadata(eventName): boolean

Parameters​

eventName​

string

Returns​

boolean