Module with api messages endpoint handlers
- Source:
- Tutorials:
Methods
(inner) decode(req, res, operationId, callback)
Decodes a Whiteflag message
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) encode(req, res, operationId, callback)
Encodes a Whiteflag message
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) getMessages(req, res, operationId, callback)
Retrieves all messages from the database
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) getReferences(req, res, operationId, callback)
Retrieves message references from the database
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) getSequence(req, res, operationId, callback)
Retrieves message sequences from the database
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) receive(req, res, operationId, callback)
Receives messages by triggering the rx event chain
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) send(req, res, operationId, callback)
Transmits messages to the blockchain through the tx event chain
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source:
(inner) validate(req, res, operationId, callback)
Checks whether a Whiteflag message is valid
Parameters:
| Name | Type | Description |
|---|---|---|
req |
Object | the http request |
res |
Object | the http response |
operationId |
string | the operation id as defined in the openapi definition |
callback |
logEndpointEventCb |
- Source: