2018-03-31 02:54:00 +02:00
|
|
|
/* This file is part of mastodon-cpp.
|
2019-03-20 06:15:43 +01:00
|
|
|
* Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
|
2019-03-28 15:30:56 +01:00
|
|
|
*
|
2018-03-31 02:54:00 +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-31 02:54:00 +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-31 02:54:00 +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-31 02:54:00 +02:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef MASTODON_CPP_EASY_RELATIONSHIP_HPP
|
|
|
|
#define MASTODON_CPP_EASY_RELATIONSHIP_HPP
|
|
|
|
|
2018-03-31 03:28:18 +02:00
|
|
|
#include <string>
|
2018-03-31 02:54:00 +02:00
|
|
|
#include <cstdint>
|
|
|
|
|
2019-08-12 04:06:43 +02:00
|
|
|
#include "../../mastodon-cpp.hpp"
|
|
|
|
#include "../entity.hpp"
|
2018-03-31 02:54:00 +02:00
|
|
|
|
2018-03-31 03:28:18 +02:00
|
|
|
using std::string;
|
2019-02-22 08:29:54 +01:00
|
|
|
using std::uint64_t;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
namespace Mastodon
|
2019-03-29 14:44:39 +01:00
|
|
|
{
|
|
|
|
namespace Easy
|
2018-03-31 02:54:00 +02:00
|
|
|
{
|
|
|
|
/*!
|
|
|
|
* @brief Class to hold relationships
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2019-03-29 14:44:39 +01:00
|
|
|
class Relationship : public Entity
|
2018-03-31 02:54:00 +02:00
|
|
|
{
|
|
|
|
public:
|
2019-03-11 20:48:54 +01:00
|
|
|
using Entity::Entity;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
2019-03-31 21:43:57 +02:00
|
|
|
virtual bool valid() const override;
|
2018-07-14 11:44:30 +02:00
|
|
|
|
2018-03-31 02:54:00 +02:00
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is blocking the account.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool blocking() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is blocking the account's domain.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool domain_blocking() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
2018-11-17 20:47:38 +01:00
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the account is endorsed by the user.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-11-17 20:47:38 +01:00
|
|
|
* @since 0.19.0
|
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool endorsed() const;
|
2018-11-17 20:47:38 +01:00
|
|
|
|
2018-03-31 02:54:00 +02:00
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is being followed by the account.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool followed_by() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is being following the account.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool following() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns the target account ID.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2019-01-27 03:44:08 +01:00
|
|
|
const string id() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is muting the account.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool muting() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is also muting notifications.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool muting_notifications() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user has requested to follow the account.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-06-14 11:17:26 +02:00
|
|
|
* @since before 0.11.0
|
2018-03-31 02:54:00 +02:00
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool requested() const;
|
2018-11-17 20:47:38 +01:00
|
|
|
|
|
|
|
/*!
|
2019-07-21 02:48:48 +02:00
|
|
|
* @brief Returns true if the user is showing notifications.
|
2019-03-29 14:44:39 +01:00
|
|
|
*
|
2018-11-17 20:47:38 +01:00
|
|
|
* @since 0.19.0
|
|
|
|
*/
|
2018-12-04 11:26:28 +01:00
|
|
|
bool showing_notifications() const;
|
2019-07-21 02:48:48 +02:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* @brief Returns true if the user is showing reblogs.
|
|
|
|
*
|
|
|
|
* @since 0.106.0
|
|
|
|
*/
|
|
|
|
bool showing_reblogs() const;
|
2018-03-31 02:54:00 +02:00
|
|
|
};
|
|
|
|
}
|
2019-03-29 14:44:39 +01:00
|
|
|
}
|
2018-03-31 02:54:00 +02:00
|
|
|
|
|
|
|
#endif // MASTODON_CPP_EASY_RELATIONSHIP_HPP
|