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/relationship.hpp

136 lines
3.5 KiB
C++
Raw Normal View History

2018-03-31 02:54:00 +02:00
/* This file is part of mastodon-cpp.
* Copyright © 2018 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODON_CPP_EASY_RELATIONSHIP_HPP
#define MASTODON_CPP_EASY_RELATIONSHIP_HPP
#include <string>
2018-03-31 02:54:00 +02:00
#include <cstdint>
// If we are compiling mastodon-cpp, use another include path
#ifdef MASTODON_CPP
#include "mastodon-cpp.hpp"
2018-04-01 03:36:11 +02:00
#include "easy/easy.hpp"
2018-03-31 02:54:00 +02:00
#else
#include <mastodon-cpp/mastodon-cpp.hpp>
2018-04-01 03:36:11 +02:00
#include <mastodon-cpp/easy/easy.hpp>
2018-03-31 02:54:00 +02:00
#endif
using std::string;
using std::uint64_t;
2018-03-31 02:54:00 +02:00
namespace Mastodon
{
/*!
* @brief Class to hold relationships
*
* before 0.11.0
2018-03-31 02:54:00 +02:00
*/
class Easy::Relationship : public Easy::Entity
{
public:
/*!
* @brief Constructs a Relationship object from a JSON string.
*
* @param json JSON string
*
* @since before 0.11.0
2018-03-31 02:54:00 +02:00
*/
explicit Relationship(const string &json);
/*!
* @brief Constructs an empty Relationship object.
*
* @since before 0.11.0
2018-03-31 02:54:00 +02:00
*/
Relationship();
2018-12-04 11:26:28 +01:00
virtual bool valid() const;
2018-03-31 02:54:00 +02:00
/*!
* @brief Returns true if the user is blocking the account
*
* @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
/*!
* @brief Returns true if the user is blocking the account's domain
*
* @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
/*!
* @brief Returns true if the account is endorsed by the user
*
* @since 0.19.0
*/
2018-12-04 11:26:28 +01:00
bool endorsed() const;
2018-03-31 02:54:00 +02:00
/*!
* @brief Returns true if the user is being followed by the account
*
* @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
/*!
* @brief Returns true if the user is being following the account
*
* @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
/*!
* @brief Returns the target account ID
*
* @since before 0.11.0
2018-03-31 02:54:00 +02:00
*/
const string id() const;
2018-03-31 02:54:00 +02:00
/*!
* @brief Returns true if the user is muting the account
*
* @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
/*!
* @brief Returns true if the user is also muting notifications
*
* @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
/*!
* @brief Returns true if the user has requested to follow the account
*
* @since before 0.11.0
2018-03-31 02:54:00 +02:00
*/
2018-12-04 11:26:28 +01:00
bool requested() const;
/*!
* @brief Returns true if the user is showing notifications
*
* @since 0.19.0
*/
2018-12-04 11:26:28 +01:00
bool showing_notifications() const;
2018-03-31 02:54:00 +02:00
};
}
#endif // MASTODON_CPP_EASY_RELATIONSHIP_HPP