Class: HttpRequestNetwork
"http-request-network".HttpRequestNetwork
Exposes RequestNetwork module configured to use http-data-access.
Hierarchy
↳ HttpRequestNetwork
Constructors
constructor
+ new HttpRequestNetwork(__namedParameters
: { decryptionProvider: IDecryptionProvider ; ethereumProviderUrl: string ; nodeConnectionConfig: AxiosRequestConfig ; signatureProvider: ISignatureProvider ; useLocalEthereumBroadcast: boolean ; useMockStorage: boolean ; web3: any }): HttpRequestNetwork
Overrides RequestNetwork.constructor
Defined in request-client.js/src/http-request-network.ts:18
Creates an instance of HttpRequestNetwork.
Parameters:
Name | Type | Default value |
---|---|---|
__namedParameters | { decryptionProvider: IDecryptionProvider ; ethereumProviderUrl: string ; nodeConnectionConfig: AxiosRequestConfig ; signatureProvider: ISignatureProvider ; useLocalEthereumBroadcast: boolean ; useMockStorage: boolean ; web3: any } | { |
Returns: HttpRequestNetwork
Properties
_mockStorage
• _mockStorage: MockStorage | undefined
Defined in request-client.js/src/http-request-network.ts:18
Public for test purpose
bitcoinDetectionProvider
• Optional
bitcoinDetectionProvider: IBitcoinDetectionProvider
Inherited from RequestNetwork.bitcoinDetectionProvider
Defined in request-client.js/src/api/request-network.ts:28
supportedIdentities
• supportedIdentities: TYPE[] = Utils.identity.supportedIdentities
Inherited from RequestNetwork.supportedIdentities
Defined in request-client.js/src/api/request-network.ts:29
Methods
_createEncryptedRequest
▸ _createEncryptedRequest(parameters
: ICreateRequestParameters, encryptionParams
: IEncryptionParameters[]): Promise<Request>
Inherited from RequestNetwork._createEncryptedRequest
Defined in request-client.js/src/api/request-network.ts:94
Creates an encrypted request.
Parameters:
Name | Type | Description |
---|---|---|
parameters | ICreateRequestParameters | Parameters to create a request |
encryptionParams | IEncryptionParameters[] | Request encryption parameters |
Returns: Promise<Request>
The created encrypted request
computeRequestId
▸ computeRequestId(parameters
: ICreateRequestParameters): Promise<RequestLogicTypes.RequestId>
Inherited from RequestNetwork.computeRequestId
Defined in request-client.js/src/api/request-network.ts:129
Gets the ID of a request without creating it.
Parameters:
Name | Type |
---|---|
parameters | ICreateRequestParameters |
Returns: Promise<RequestLogicTypes.RequestId>
The requestId
createRequest
▸ createRequest(parameters
: ICreateRequestParameters): Promise<Request>
Inherited from RequestNetwork.createRequest
Defined in request-client.js/src/api/request-network.ts:62
Creates a request.
Parameters:
Name | Type |
---|---|
parameters | ICreateRequestParameters |
Returns: Promise<Request>
The created request
fromIdentity
▸ fromIdentity(identity
: IIdentity, updatedBetween?
: ITimestampBoundaries, options?
: { disablePaymentDetection: boolean }): Promise<Request[]>
Inherited from RequestNetwork.fromIdentity
Defined in request-client.js/src/api/request-network.ts:189
Create an array of request instances from an identity
Parameters:
Name | Type | Description |
---|---|---|
identity | IIdentity | |
updatedBetween? | ITimestampBoundaries | filter the requests with time boundaries |
options? | { disablePaymentDetection: boolean } | options |
Returns: Promise<Request[]>
the Requests
fromMultipleIdentities
▸ fromMultipleIdentities(identities
: IIdentity[], updatedBetween?
: ITimestampBoundaries, options?
: { disablePaymentDetection: boolean }): Promise<Request[]>
Inherited from RequestNetwork.fromMultipleIdentities
Defined in request-client.js/src/api/request-network.ts:208
Create an array of request instances from multiple identities
Parameters:
Name | Type | Description |
---|---|---|
identities | IIdentity[] | |
updatedBetween? | ITimestampBoundaries | filter the requests with time boundaries |
options? | { disablePaymentDetection: boolean } | - |
Returns: Promise<Request[]>
the requests
fromMultipleTopics
▸ fromMultipleTopics(topics
: any[], updatedBetween?
: ITimestampBoundaries, options?
: { disablePaymentDetection: boolean }): Promise<Request[]>
Inherited from RequestNetwork.fromMultipleTopics
Defined in request-client.js/src/api/request-network.ts:286
Create an array of request instances from a multiple topics
Parameters:
Name | Type | Description |
---|---|---|
topics | any[] | |
updatedBetween? | ITimestampBoundaries | filter the requests with time boundaries |
options? | { disablePaymentDetection: boolean } | options |
Returns: Promise<Request[]>
the Requests
fromRequestId
▸ fromRequestId(requestId
: RequestLogicTypes.RequestId, options?
: { disablePaymentDetection: boolean }): Promise<Request>
Inherited from RequestNetwork.fromRequestId
Defined in request-client.js/src/api/request-network.ts:143
Create a Request instance from an existing Request's ID
Parameters:
Name | Type | Description |
---|---|---|
requestId | RequestLogicTypes.RequestId | The ID of the Request |
options? | { disablePaymentDetection: boolean } | options |
Returns: Promise<Request>
the Request
fromTopic
▸ fromTopic(topic
: any, updatedBetween?
: ITimestampBoundaries, options?
: { disablePaymentDetection: boolean }): Promise<Request[]>
Inherited from RequestNetwork.fromTopic
Defined in request-client.js/src/api/request-network.ts:232
Create an array of request instances from a topic
Parameters:
Name | Type | Description |
---|---|---|
topic | any | |
updatedBetween? | ITimestampBoundaries | filter the requests with time boundaries |
options? | { disablePaymentDetection: boolean } | options |
Returns: Promise<Request[]>
the Requests