noury/mirror-chatterino2
1
0
Fork 0
mirror of https://github.com/Chatterino/chatterino2.git synced 2024-11-21 22:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation to the APIRequest constructor

Browse source
This commit is contained in:
Mm2PL 2022-09-16 23:47:07 +02:00
parent 0d3f0b7585
commit fc4c1c5fb9
No known key found for this signature in database
GPG key ID: 94AC9B80EFA15ED9
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/common/APIRequest.hpp
View file

@ -44,6 +44,15 @@ public:
APIRequest(const APIRequest<OkType, ErrorType> &other) = delete;
APIRequest &operator=(const APIRequest<OkType, ErrorType> &other) = delete;
/**
* @brief Constructs an APIRequest instance and a APIRequestData.
*
* @param[successTransformer] a function that will transform a NetworkResult into the desired type (OkType), for example decode JSON
* @param[errorTransformer] an optional function that will transform a NetworkResult into the desired type (ErrorType)
* @param[onFinally] an optional function that will be called regardless of the status. This is explicitly different from calling finally(...) as this is for cleanup of the decoding/transformer logic, they are separate
*
* APIRequest is a wrapper around NetworkRequest
*/
explicit APIRequest(
QUrl url, NetworkRequestType requestType,
std::function<OkType(NetworkResult)> successTransformer,