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

87 lines
2.1 KiB
C++
Raw Normal View History

2018-05-23 20:21:41 +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-05-23 20:21:41 +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-05-23 20:21:41 +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-05-23 20:21:41 +02:00
*
2019-08-15 22:53:38 +02:00
* You should have received a copy of the GNU Affero General Public License
2018-05-23 20:21:41 +02:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODON_CPP_EASY_PUSHSUBSCRIPTION_HPP
#define MASTODON_CPP_EASY_PUSHSUBSCRIPTION_HPP
#include <string>
2019-05-13 21:26:55 +02:00
#include <vector>
2018-05-23 20:21:41 +02:00
#include <cstdint>
#include <map>
2019-08-12 04:06:43 +02:00
#include "../../mastodon-cpp.hpp"
#include "../entity.hpp"
2018-05-23 20:21:41 +02:00
using std::string;
2019-05-13 21:26:55 +02:00
using std::vector;
2018-05-23 20:21:41 +02:00
namespace Mastodon
2019-03-29 14:44:39 +01:00
{
namespace Easy
2018-05-23 20:21:41 +02:00
{
/*!
* @brief Class to hold push subscriptions.
2018-05-25 14:21:35 +02:00
*
* @since 0.14.0
2018-05-23 20:21:41 +02:00
*/
2019-03-29 14:44:39 +01:00
class PushSubscription : public Entity
2018-05-23 20:21:41 +02:00
{
public:
2019-03-11 20:48:54 +01:00
using Entity::Entity;
2018-05-23 20:21:41 +02:00
virtual bool valid() const override;
2018-05-23 20:21:41 +02:00
/*!
* @brief Returns push subscription ID
2019-03-29 14:44:39 +01:00
*
* @since 0.14.0
2018-05-23 20:21:41 +02:00
*/
const string id() const;
2018-05-23 20:21:41 +02:00
/*!
* @brief Returns the endpoint URL
2019-03-29 14:44:39 +01:00
*
* @since 0.14.0
2018-05-23 20:21:41 +02:00
*/
const string endpoint() const;
/*!
* @brief Returns the server public key for signature verification
2019-03-29 14:44:39 +01:00
*
* @since 0.14.0
2018-05-23 20:21:41 +02:00
*/
const string server_key() const;
/*!
* @brief Returns a vector of Easy::alert_type.
2019-03-29 14:44:39 +01:00
*
* @since 0.100.0
2018-05-23 20:21:41 +02:00
*/
2019-05-13 21:26:55 +02:00
const vector<Easy::alert_type> alerts() const;
2018-05-23 20:21:41 +02:00
protected:
/*!
* @brief Converts string to bool
*
* @return `true` if str is equal to "true", `false` otherwise
*/
2018-12-04 11:26:28 +01:00
bool s_to_b(const string &str) const;
2018-05-23 20:21:41 +02:00
};
}
2019-03-29 14:44:39 +01:00
}
2018-05-23 20:21:41 +02:00
#endif // MASTODON_CPP_EASY_PUSHSUBSCRIPTION_HPP