This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/src/easy/entities/instance.hpp

133 lines
3.3 KiB
C++
Raw Normal View History

2018-03-30 20:08:47 +02:00
/* This file is part of mastodon-cpp.
2019-03-20 06:15:43 +01:00
* Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
*
2018-03-30 20:08:47 +02:00
* This program is free software: you can redistribute it and/or modify
2019-08-15 22:53:38 +02:00
* it under the terms of the GNU Affero General Public License as published by
2018-03-30 20:08:47 +02:00
* 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
2019-08-15 22:53:38 +02:00
* GNU Affero General Public License for more details.
2018-03-30 20:08:47 +02:00
*
2019-08-15 22:53:38 +02:00
* You should have received a copy of the GNU Affero General Public License
2018-03-30 20:08:47 +02:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODON_CPP_EASY_INSTANCE_HPP
#define MASTODON_CPP_EASY_INSTANCE_HPP
#include <string>
#include <vector>
using std::uint64_t;
2018-12-04 09:42:26 +01:00
2019-08-12 04:06:43 +02:00
#include "../../mastodon-cpp.hpp"
#include "../entity.hpp"
#include "account.hpp"
2018-03-30 20:08:47 +02:00
using std::string;
namespace Mastodon
2019-03-29 14:44:39 +01:00
{
namespace Easy
2018-03-30 20:08:47 +02:00
{
/*!
* @brief Class to hold instances.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
2019-03-29 14:44:39 +01:00
class Instance : public Entity
2018-03-30 20:08:47 +02:00
{
public:
2019-03-11 20:48:54 +01:00
using Entity::Entity;
2018-03-30 20:08:47 +02:00
virtual bool valid() const override;
2018-03-30 20:08:47 +02:00
/*!
* @brief Returns the Account of the admin or another contact person.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const Account contact_account() const;
/*!
* @brief Returns the description of the instance.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const string description() const;
/*!
* @brief Returns the email address which can be used to contact the
* instance administrator.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const string email() const;
/*!
* @brief Returns a vector of ISO 6391 language codes the instance has
* chosen to advertise.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const vector<string> languages() const;
2019-05-13 21:26:55 +02:00
/*!
* @brief Returns the thumbnail of the instance.
*
* @since 0.106.0
*/
const string thumbnail() const;
2018-03-30 20:08:47 +02:00
/*!
* @brief Returns the title of the instance.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const string title() const;
/*!
* @brief Returns the URI of the instance.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const string uri() const;
/*!
* @brief Returns the URL for the streaming API and possibly others.
2019-03-29 14:44:39 +01:00
*
* @since 0.106.0
2018-03-30 20:08:47 +02:00
*/
const Easy::urls_type urls() const;
/*!
* @brief Returns statistics about the instance.
*
* @since 0.106.0
*/
const Easy::stats_type stats() const;
2018-03-30 20:08:47 +02:00
/*!
* @brief Returns the version used by the instance.
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
2018-03-30 20:08:47 +02:00
*/
const string version() const;
2018-12-04 09:42:26 +01:00
/*!
* @brief Returns the maximum chars a post can have
*
* This parameter is not supported by upstream Mastodon. If it
* is not found, 500 is returned.
*
* @since 0.20.0
*/
uint64_t max_toot_chars() const;
2018-03-30 20:08:47 +02:00
};
}
2019-03-29 14:44:39 +01:00
}
2018-03-30 20:08:47 +02:00
#endif // MASTODON_CPP_EASY_INSTANCE_HPP