MetadataHttp | symbol-sdk

Metadata http repository.

since: 1.0

Hierarchy

Http
- MetadataHttp

Implements

MetadataRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MetadataHttp(url: string): MetadataHttp

Overrides Http.constructor
- Defined in infrastructure/MetadataHttp.ts:41
Constructor

Parameters
- url: string
  
  the url.
Returns MetadataHttp

Properties

Protected Readonly url

url: string

Methods

Private buildMetadata

buildMetadata(metadata: MetadataDTO): Metadata

- Defined in infrastructure/MetadataHttp.ts:189
It maps MetadataDTO into a Metadata

Parameters
- metadata: MetadataDTO
  
  the dto
Returns Metadata

the model Metadata.

Protected call

call<D, M>(remoteCall: Promise<{ body: D; response: IncomingMessage }>, mapper: (value: D, index: number) => M): Observable<M>

Inherited from Http.call
- Defined in infrastructure/Http.ts:88
This method knows how to call, convert and handle exception when doing remote http operations.

Type parameters
- D
- M
Parameters
- remoteCall: Promise<{ body: D; response: IncomingMessage }>
  
  the remote call
- mapper: (value: D, index: number) => M
  
  the mapper from dto to the model object.
  - - (value: D, index: number): M
    - Parameters
      - value: D
      - index: number
      Returns M
Returns Observable<M>

createNetworkTypeObservable

createNetworkTypeObservable(networkType?: NetworkType | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:39
Parameters
- Optional networkType: NetworkType | Observable<NetworkType>
Returns Observable<NetworkType>

errorHandling

errorHandling(error: any): Error

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:62
Parameters
- error: any
Returns Error

getAccountMetadata

getAccountMetadata(address: Address, queryParams?: QueryParams): Observable<Metadata[]>

Implementation of MetadataRepository.getAccountMetadata
- Defined in infrastructure/MetadataHttp.ts:59
Returns the account metadata given an account id.

Parameters
- address: Address
  
  Account address to be created from PublicKey or RawAddress
- Optional queryParams: QueryParams
  
  Optional query parameters
Returns Observable<Metadata[]>

Observable<Metadata[]>

getAccountMetadataByKey

getAccountMetadataByKey(address: Address, key: string): Observable<Metadata[]>

Implementation of MetadataRepository.getAccountMetadataByKey
- Defined in infrastructure/MetadataHttp.ts:77
Returns the account metadata given an account id and a key

Parameters
- address: Address
  
  Account address to be created from PublicKey or RawAddress
- key: string
  
  Metadata key
Returns Observable<Metadata[]>

Observable<Metadata[]>

getAccountMetadataByKeyAndSender

getAccountMetadataByKeyAndSender(address: Address, key: string, sourceAddress: Address): Observable<Metadata>

Implementation of MetadataRepository.getAccountMetadataByKeyAndSender
- Defined in infrastructure/MetadataHttp.ts:90
Returns the account metadata given an account id and a key

Parameters
- address: Address
  
  Account address to be created from PublicKey or RawAddress
- key: string
  
  Metadata key
- sourceAddress: Address
  
  Sender address
Returns Observable<Metadata>

Observable

getMosaicMetadata

getMosaicMetadata(mosaicId: MosaicId, queryParams?: QueryParams): Observable<Metadata[]>

Implementation of MetadataRepository.getMosaicMetadata
- Defined in infrastructure/MetadataHttp.ts:102
Returns the mosaic metadata given a mosaic id.

Parameters
- mosaicId: MosaicId
  
  Mosaic identifier.
- Optional queryParams: QueryParams
  
  Optional query parameters
Returns Observable<Metadata[]>

Observable<Metadata[]>

getMosaicMetadataByKey

getMosaicMetadataByKey(mosaicId: MosaicId, key: string): Observable<Metadata[]>

Implementation of MetadataRepository.getMosaicMetadataByKey
- Defined in infrastructure/MetadataHttp.ts:120
Returns the mosaic metadata given a mosaic id and metadata key.

Parameters
- mosaicId: MosaicId
  
  Mosaic identifier.
- key: string
  
  Metadata key.
Returns Observable<Metadata[]>

Observable<Metadata[]>

getMosaicMetadataByKeyAndSender

getMosaicMetadataByKeyAndSender(mosaicId: MosaicId, key: string, sourceAddress: Address): Observable<Metadata>

Implementation of MetadataRepository.getMosaicMetadataByKeyAndSender
- Defined in infrastructure/MetadataHttp.ts:133
Returns the mosaic metadata given a mosaic id and metadata key.

Parameters
- mosaicId: MosaicId
  
  Mosaic identifier.
- key: string
  
  Metadata key.
- sourceAddress: Address
  
  Sender address
Returns Observable<Metadata>

Observable

getNamespaceMetadata

getNamespaceMetadata(namespaceId: NamespaceId, queryParams?: QueryParams): Observable<Metadata[]>

Implementation of MetadataRepository.getNamespaceMetadata
- Defined in infrastructure/MetadataHttp.ts:146
Returns the mosaic metadata given a mosaic id.

Parameters
- namespaceId: NamespaceId
  
  Namespace identifier.
- Optional queryParams: QueryParams
  
  Optional query parameters
Returns Observable<Metadata[]>

Observable<Metadata[]>

getNamespaceMetadataByKey

getNamespaceMetadataByKey(namespaceId: NamespaceId, key: string): Observable<Metadata[]>

Implementation of MetadataRepository.getNamespaceMetadataByKey
- Defined in infrastructure/MetadataHttp.ts:164
Returns the mosaic metadata given a mosaic id and metadata key.

Parameters
- namespaceId: NamespaceId
  
  Namespace identifier.
- key: string
  
  Metadata key.
Returns Observable<Metadata[]>

Observable<Metadata[]>

getNamespaceMetadataByKeyAndSender

getNamespaceMetadataByKeyAndSender(namespaceId: NamespaceId, key: string, sourceAddress: Address): Observable<Metadata>

Implementation of MetadataRepository.getNamespaceMetadataByKeyAndSender
- Defined in infrastructure/MetadataHttp.ts:177
Returns the namespace metadata given a mosaic id and metadata key.

Parameters
- namespaceId: NamespaceId
  
  Namespace identifier.
- key: string
  
  Metadata key.
- sourceAddress: Address
  
  Sender address
Returns Observable<Metadata>

Observable

queryParams

queryParams(queryParams?: QueryParams): any

Inherited from Http.queryParams
- Defined in infrastructure/Http.ts:54
Parameters
- Optional queryParams: QueryParams
Returns any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Returns MetadataHttp

Properties

Protected Readonly url

Methods

Private buildMetadata

Parameters

metadata: MetadataDTO

Returns Metadata

Protected call

Type parameters

D

M

Parameters

remoteCall: Promise<{ body: D; response: IncomingMessage }>

mapper: (value: D, index: number) => M

Parameters

value: D

index: number

Returns M

Returns Observable<M>

createNetworkTypeObservable

Parameters

Optional networkType: NetworkType | Observable<NetworkType>

Returns Observable<NetworkType>

errorHandling

Parameters

error: any

Returns Error

getAccountMetadata

Parameters

address: Address

Optional queryParams: QueryParams

Returns Observable<Metadata[]>

getAccountMetadataByKey

Parameters

address: Address

key: string

Returns Observable<Metadata[]>

getAccountMetadataByKeyAndSender

Parameters

address: Address

key: string

sourceAddress: Address

Returns Observable<Metadata>

getMosaicMetadata

Parameters

mosaicId: MosaicId

Optional queryParams: QueryParams

Returns Observable<Metadata[]>

getMosaicMetadataByKey

Parameters

mosaicId: MosaicId

key: string

Returns Observable<Metadata[]>

getMosaicMetadataByKeyAndSender

Parameters

mosaicId: MosaicId

key: string

sourceAddress: Address

Returns Observable<Metadata>

getNamespaceMetadata

Parameters

namespaceId: NamespaceId

Optional queryParams: QueryParams

Returns Observable<Metadata[]>

getNamespaceMetadataByKey

Parameters

namespaceId: NamespaceId

key: string

Returns Observable<Metadata[]>