Class RestrictionAccountHttp

RestrictionAccount http repository.

since: 1.0

Hierarchy

Http
- RestrictionAccountHttp

Implements

RestrictionAccountRepository

Index

Constructors

constructor

Properties

fetchApi
url

Methods

Constructors

constructor

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

Overrides Http.constructor
- Defined in infrastructure/RestrictionAccountHttp.ts:38
Constructor

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

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?: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:76
Parameters
- Optional networkType: MAIN_NET | TEST_NET | MIJIN | MIJIN_TEST | PRIVATE | PRIVATE_TEST | Observable<NetworkType>
Returns Observable<NetworkType>

getAccountRestrictions

getAccountRestrictions(address: Address): Observable<AccountRestrictions>

Implementation of RestrictionAccountRepository.getAccountRestrictions
- Defined in infrastructure/RestrictionAccountHttp.ts:55
Get Account restrictions.

Parameters
- address: Address
  
  the address
Returns Observable<AccountRestrictions>

Observable<AccountRestrictions[]>

getAccountRestrictionsMerkle

getAccountRestrictionsMerkle(address: Address): Observable<MerkleStateInfo>

Implementation of RestrictionAccountRepository.getAccountRestrictionsMerkle
- Defined in infrastructure/RestrictionAccountHttp.ts:67
Get Account restrictions merkle.

Parameters
- address: Address
  
  the address
Returns Observable<MerkleStateInfo>

Observable

search

search(criteria: RestrictionAccountSearchCriteria): Observable<Page<AccountRestrictions>>

Implementation of RestrictionAccountRepository.search
- Defined in infrastructure/RestrictionAccountHttp.ts:77
Returns a mosaic restrictions page based on the criteria.

Parameters
- criteria: RestrictionAccountSearchCriteria
  
  the criteria
Returns Observable<Page<AccountRestrictions>>

a page of MosaicRestriction

streamer

streamer(): RestrictionAccountPaginationStreamer

Implementation of RestrictionAccountRepository.streamer
- Defined in infrastructure/RestrictionAccountHttp.ts:90
It creates a streamer for this searcher.

Returns RestrictionAccountPaginationStreamer

Static errorHandling

errorHandling(error: any): Promise<Error>

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

Generated using TypeDoc