tastytea/mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity

updated documentation

Browse Source
This commit is contained in:
tastytea 2018-02-09 22:37:57 +01:00
parent fec50bc146
commit 01996113de
Signed by: tastytea
GPG Key ID: 59346E0EA35C67E5
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/mastodon-cpp.hpp
View File

@ -169,6 +169,20 @@ public:
*/
const std::string urlencode(const std::string &str) const;
/*!
* @brief Register application, step 1/2
*
* @param instance
* @param client_name The name of the application
* @param redirect_uri urn:ietf:wg:oauth:2.0:oob for none
* @param scopes Scopes (read, write, follow, space separated)
* @param website The website of the application
* @param client_id Returned
* @param client_secret Returned
* @param url Returned, used to generate code for register_app2
*
* @return @ref error "Error code".
*/
const std::uint16_t register_app1(const std::string &instance,
const std::string &client_name,
const std::string &redirect_uri,
@ -177,6 +191,19 @@ public:
std::string &client_id,
std::string &client_secret,
std::string &url);
/*!
* @brief Register application, step 2/2
*
* @param instance
* @param client_id
* @param client_secret
* @param redirect_uri urn:ietf:wg:oauth:2.0:oob for none
* @param code The code generated by the website
* @param access_token Returned
*
* @return @ref error "Error code".
*/
const std::uint16_t register_app2(const std::string &instance,
const std::string &client_id,
const std::string &client_secret,
@ -382,8 +409,6 @@ public:
*
* @param call A call defined in Mastodon::API::v1
* @param argument The non-optional argument
* @param answer The answer from the server. Usually JSON. On error an
* empty string.
*
* @return @ref error "Error code".
*/