Class RestrictionMosaicHttp

RestrictionMosaic http repository.

since: 1.0

Hierarchy

Http
- RestrictionMosaicHttp

Implements

RestrictionMosaicRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RestrictionMosaicHttp(url: string, fetchApi?: any): RestrictionMosaicHttp

Overrides Http.constructor
- Defined in infrastructure/RestrictionMosaicHttp.ts:57
Constructor

Parameters
- url: string
  
  Base catapult-rest url
- Optional fetchApi: any
  
  fetch function to be used when performing rest requests.
Returns RestrictionMosaicHttp

Properties

Protected Optional Readonly fetchApi

fetchApi?: any

Protected Readonly url

url: string

Methods

Protected call

call<D, M>(remoteCall: Promise<D>, mapper: (value: D) => M): Observable<M>

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

Type parameters
- D
- M
Parameters
- remoteCall: Promise<D>
  
  the remote call
- mapper: (value: D) => M
  
  the mapper from dto to the model object.
  - - (value: D): M
    - Parameters
      - value: D
      Returns M
Returns Observable<M>

config

config(): Configuration

Inherited from Http.config
- Defined in infrastructure/Http.ts:86
Returns Configuration

createNetworkTypeObservable

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

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

getMosaicRestrictions

getMosaicRestrictions(compositeHash: string): Observable<MosaicRestriction>

Implementation of RestrictionMosaicRepository.getMosaicRestrictions
- Defined in infrastructure/RestrictionMosaicHttp.ts:130
Returns mosaic restrictions by composite hash

Parameters
- compositeHash: string
Returns Observable<MosaicRestriction>

getMosaicRestrictionsMerkle

getMosaicRestrictionsMerkle(compositeHash: string): Observable<MerkleStateInfo>

Implementation of RestrictionMosaicRepository.getMosaicRestrictionsMerkle
- Defined in infrastructure/RestrictionMosaicHttp.ts:134
Returns mosaic restrictions by composite hash

Parameters
- compositeHash: string
Returns Observable<MerkleStateInfo>

search

search(criteria: RestrictionMosaicSearchCriteria): Observable<Page<MosaicRestriction>>

Implementation of RestrictionMosaicRepository.search
- Defined in infrastructure/RestrictionMosaicHttp.ts:68
Returns a mosaic restrictions page based on the criteria.

Parameters
- criteria: RestrictionMosaicSearchCriteria
  
  the criteria
Returns Observable<Page<MosaicRestriction>>
a page of MosaicRestriction

streamer

streamer(): RestrictionMosaicPaginationStreamer

Implementation of RestrictionMosaicRepository.streamer
- Defined in infrastructure/RestrictionMosaicHttp.ts:83
It creates a streamer for this searcher.

Returns RestrictionMosaicPaginationStreamer

Static errorHandling

errorHandling(error: any): Promise<Error>

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:35
Parameters
- error: any
Returns Promise<Error>

Static Private toMosaicAddressRestrictionItem

toMosaicAddressRestrictionItem(restriction: MosaicAddressRestrictionEntryDTO): MosaicAddressRestrictionItem

- Defined in infrastructure/RestrictionMosaicHttp.ts:126
Parameters
- restriction: MosaicAddressRestrictionEntryDTO
Returns MosaicAddressRestrictionItem

Static Private toMosaicGlobalRestrictionItem

toMosaicGlobalRestrictionItem(restriction: MosaicGlobalRestrictionEntryDTO): MosaicGlobalRestrictionItem

- Defined in infrastructure/RestrictionMosaicHttp.ts:117
Parameters
- restriction: MosaicGlobalRestrictionEntryDTO
Returns MosaicGlobalRestrictionItem

Generated using TypeDoc