Class SecretLockHttp

SecretLock http repository.

since: 1.0

Hierarchy

Http
- SecretLockHttp

Implements

SecretLockRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

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

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>

getSecretLock

getSecretLock(compositeHash: string): Observable<SecretLockInfo>

Implementation of SecretLockRepository.getSecretLock
- Defined in infrastructure/SecretLockHttp.ts:52
Get secret lock info of the given id.

Parameters
- compositeHash: string
Returns Observable<SecretLockInfo>

getSecretLockMerkle

getSecretLockMerkle(compositeHash: string): Observable<MerkleStateInfo>

Implementation of SecretLockRepository.getSecretLockMerkle
- Defined in infrastructure/SecretLockHttp.ts:56
Get secret lock merkle info of the given id.

Parameters
- compositeHash: string
Returns Observable<MerkleStateInfo>

search

search(criteria: SecretLockSearchCriteria): Observable<Page<SecretLockInfo>>

Implementation of SecretLockRepository.search
- Defined in infrastructure/SecretLockHttp.ts:65
Gets an array of SecretLockInfo.

Parameters
- criteria: SecretLockSearchCriteria
  
  SecretLock search criteria
Returns Observable<Page<SecretLockInfo>>
Observable<Page>

streamer

streamer(): SecretLockPaginationStreamer

Implementation of SecretLockRepository.streamer
- Defined in infrastructure/SecretLockHttp.ts:79
It creates a streamer for this searcher.

Returns SecretLockPaginationStreamer

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