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

108 lines
2.9 KiB
C++
Raw Normal View History

/* 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_NOTIFICATION_HPP
#define MASTODON_CPP_EASY_NOTIFICATION_HPP
#include <string>
#include <cstdint>
#include <chrono>
// 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-04-03 00:13:21 +02:00
#include "easy/entities/account.hpp"
#include "easy/entities/status.hpp"
#else
#include <mastodon-cpp/mastodon-cpp.hpp>
2018-04-01 03:36:11 +02:00
#include <mastodon-cpp/easy/easy.hpp>
2018-04-11 16:06:32 +02:00
#include <mastodon-cpp/easy/entities/account.hpp>
#include <mastodon-cpp/easy/entities/status.hpp>
#endif
using std::string;
2018-03-31 19:43:15 +02:00
using std::uint_fast64_t;
using std::chrono::system_clock;
namespace Mastodon
{
/*!
* @brief Class to hold notifications
*
* @since before 0.11.0
*/
class Easy::Notification : public Easy::Entity
{
public:
/*!
* @brief Constructs a Notification object from a JSON string.
*
* @param json JSON string
*
* @since before 0.11.0
*/
explicit Notification(const string &json);
/*!
* @brief Constructs an empty Notification object.
*
* @since before 0.11.0
*/
Notification();
2018-12-04 11:26:28 +01:00
virtual bool valid() const;
/*!
* @brief Returns the Account sending the notification to the user
*
* @since before 0.11.0
*/
const Account account() const;
/*!
* @brief Returns time of creation
*
* @since before 0.11.0
*/
const system_clock::time_point created_at() const;
/*!
* @brief Returns notification ID
*
* @since before 0.11.0
*/
2018-12-04 11:26:28 +01:00
uint_fast64_t id() const;
/*!
* @brief Returns the Status associated with the notification, if
* applicable
*
* @since before 0.11.0
*/
const Status status() const;
/*!
* @brief Returns notification type
*
* @since before 0.11.0
*/
2018-12-04 11:26:28 +01:00
Easy::notification_type type() const;
};
}
#endif // MASTODON_CPP_EASY_NOTIFICATION_HPP