Module with api messages endpoint handlers
- Source:
- Tutorials:
Methods
(inner) addResourceData(wfMessage, reqPath, resMetaopt) → {Object}
Adds information of a single Whiteflag message to meta data
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
wfMessage |
wfMessage | ||
reqPath |
string | ||
resMeta |
Object |
<optional> |
the meta data object to add message details to |
- Source:
Returns:
the updated meta data object
- Type
- Object
(inner) getMessage(req, res, operationId, callback)
Gets message by transaction hash
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) receiveMessage(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) sendMessage(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: