Class AccountHttp

Account http repository.

since: 1.0

Hierarchy

Http
- AccountHttp

Implements

AccountRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides Http.constructor
- Defined in infrastructure/AccountHttp.ts:47
Constructor

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

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>

getAccountInfo

getAccountInfo(address: Address): Observable<AccountInfo>

Implementation of AccountRepository.getAccountInfo
- Defined in infrastructure/AccountHttp.ts:57
Gets an AccountInfo for an account.

Parameters
- address: Address
  
  Address
Returns Observable<AccountInfo>
Observable

getAccountInfoMerkle

getAccountInfoMerkle(address: Address): Observable<MerkleStateInfo>

Implementation of AccountRepository.getAccountInfoMerkle
- Defined in infrastructure/AccountHttp.ts:101
Returns the merkle information of the given account.

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

getAccountsInfo

getAccountsInfo(addresses: Address[]): Observable<AccountInfo[]>

Implementation of AccountRepository.getAccountsInfo
- Defined in infrastructure/AccountHttp.ts:66
Gets AccountsInfo for different accounts.

Parameters
- addresses: Address[]
  
  List of Address
Returns Observable<AccountInfo[]>
Observable<AccountInfo[]>

search

search(criteria: AccountSearchCriteria): Observable<Page<AccountInfo>>

Implementation of AccountRepository.search
- Defined in infrastructure/AccountHttp.ts:78
Gets an array of accounts.

Parameters
- criteria: AccountSearchCriteria
  
  Account search criteria
Returns Observable<Page<AccountInfo>>
Observable<Page>

streamer

streamer(): AccountPaginationStreamer

Implementation of AccountRepository.streamer
- Defined in infrastructure/AccountHttp.ts:92
It creates a streamer for this searcher.

Returns AccountPaginationStreamer

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