mastodonpp/include/instance.hpp

132 lines
3.0 KiB
C++

/* 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"
#include <cstdint>
#include <string>
#include <string_view>
namespace mastodonpp
{
using std::uint64_t;
using std::string;
using std::string_view;
/*!
* @brief Holds the access data of an instance.
*
* @since 0.1.0
*
* @headerfile instance.hpp mastodonpp/instance.hpp
*/
class Instance : public CURLWrapper
{
public:
/*!
* @brief Construct a new Instance object.
*
* Also queries `/api/v1/instance` for `max_toot_chars'.
*
* @param hostname The hostname of the instance.
* @param access_token Your access token.
*
* @since 0.1.0
*/
explicit Instance(string_view hostname, string_view 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;
}
/*!
* @brief Returns the maximum number of characters per post.
*
* @since 0.1.0
*/
[[nodiscard]]
uint64_t get_max_chars();
/*! @copydoc CURLWrapper::set_proxy(string_view)
*
* Sets also the proxy for all Connection%s that are initialized with this
* Instance afterwards.
*/
void set_proxy(const string_view proxy)
{
_proxy = proxy;
CURLWrapper::set_proxy(proxy);
}
/*!
* @brief Returns the proxy string that was previously set.
*
* Does not return the proxy if it was set from an environment variable.
*
* @since 0.1.0
*/
string_view get_proxy() const
{
return _proxy;
}
private:
const string _hostname;
const string _baseuri;
string _access_token;
uint64_t _max_chars;
string _proxy;
};
} // namespace mastodonpp
#endif // MASTODONPP_INSTANCE_HPP