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

126 lines
3.1 KiB
C++

/* This file is part of mastodon-cpp.
* Copyright © 2018, 2019 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 MASTODON_CPP_EASY_RELATIONSHIP_HPP
#define MASTODON_CPP_EASY_RELATIONSHIP_HPP
#include <string>
#include <cstdint>
#include "../../mastodon-cpp.hpp"
#include "../entity.hpp"
using std::string;
using std::uint64_t;
namespace Mastodon
{
namespace Easy
{
/*!
* @brief Class to hold relationships
*
* before 0.11.0
*/
class Relationship : public Entity
{
public:
using Entity::Entity;
virtual bool valid() const override;
/*!
* @brief Returns true if the user is blocking the account.
*
* @since before 0.11.0
*/
bool blocking() const;
/*!
* @brief Returns true if the user is blocking the account's domain.
*
* @since before 0.11.0
*/
bool domain_blocking() const;
/*!
* @brief Returns true if the account is endorsed by the user.
*
* @since 0.19.0
*/
bool endorsed() const;
/*!
* @brief Returns true if the user is being followed by the account.
*
* @since before 0.11.0
*/
bool followed_by() const;
/*!
* @brief Returns true if the user is being following the account.
*
* @since before 0.11.0
*/
bool following() const;
/*!
* @brief Returns the target account ID.
*
* @since before 0.11.0
*/
const string id() const;
/*!
* @brief Returns true if the user is muting the account.
*
* @since before 0.11.0
*/
bool muting() const;
/*!
* @brief Returns true if the user is also muting notifications.
*
* @since before 0.11.0
*/
bool muting_notifications() const;
/*!
* @brief Returns true if the user has requested to follow the account.
*
* @since before 0.11.0
*/
bool requested() const;
/*!
* @brief Returns true if the user is showing notifications.
*
* @since 0.19.0
*/
bool showing_notifications() const;
/*!
* @brief Returns true if the user is showing reblogs.
*
* @since 0.106.0
*/
bool showing_reblogs() const;
};
}
}
#endif // MASTODON_CPP_EASY_RELATIONSHIP_HPP