mastodonpp/include/instance.hpp

111 lines
2.4 KiB
C++
Raw Normal View History

2020-01-03 12:42:10 +01:00
/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_INSTANCE_HPP
#define MASTODONPP_INSTANCE_HPP
#include "curl_wrapper.hpp"
2020-01-04 11:38:06 +01:00
2020-01-05 11:06:50 +01:00
#include <cstdint>
2020-01-03 12:42:10 +01:00
#include <string>
#include <string_view>
2020-01-03 12:42:10 +01:00
namespace mastodonpp
{
2020-01-05 11:06:50 +01:00
using std::uint64_t;
2020-01-03 12:42:10 +01:00
using std::string;
using std::string_view;
2020-01-03 12:42:10 +01:00
2020-01-03 13:05:00 +01:00
/*!
* @brief Holds the access data of an instance.
2020-01-03 13:05:00 +01:00
*
* @since 0.1.0
2020-01-04 12:04:47 +01:00
*
* @headerfile instance.hpp mastodonpp/instance.hpp
2020-01-03 13:05:00 +01:00
*/
class Instance : public CURLWrapper
2020-01-03 12:42:10 +01:00
{
public:
/*!
* @brief Construct a new Instance object.
*
2020-01-05 11:06:50 +01:00
* Also queries `/api/v1/instance` for `max_toot_chars'.
*
* @param hostname The hostname of the instance.
2020-01-03 12:42:10 +01:00
* @param access_token Your access token.
*
* @since 0.1.0
*/
explicit Instance(string hostname, string access_token);
/*!
* @brief Returns the hostname.
*
* @since 0.1.0
*/
[[nodiscard]]
inline string_view get_hostname() const
{
return _hostname;
}
/*!
* @brief Returns the base URI.
*
* The base URI is https://” + the hostname.
*
* @since 0.1.0
*/
[[nodiscard]]
inline string_view get_baseuri() const
{
return _baseuri;
}
/*!
* @brief Returns the access token.
*
* @since 0.1.0
*/
[[nodiscard]]
inline string_view get_access_token() const
{
return _access_token;
}
2020-01-05 11:06:50 +01:00
/*!
* @brief Returns the maximum number of characters per post.
*
* @since 0.1.0
*/
[[nodiscard]]
inline uint64_t get_max_chars() const
{
return _max_chars;
}
2020-01-03 12:42:10 +01:00
private:
const string _hostname;
const string _baseuri;
2020-01-03 12:42:10 +01:00
string _access_token;
2020-01-05 11:06:50 +01:00
uint64_t _max_chars;
2020-01-03 12:42:10 +01:00
};
} // namespace mastodonpp
#endif // MASTODONPP_INSTANCE_HPP