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

79 lines
2.0 KiB
C++
Raw Normal View History

/* This file is part of mastodon-cpp.
2019-03-20 06:15:43 +01:00
* Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
*
* 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
* 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.
*
2019-08-15 22:53:38 +02:00
* 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_RESULTS_HPP
#define MASTODON_CPP_EASY_RESULTS_HPP
#include <string>
#include <vector>
2019-08-12 04:06:43 +02:00
#include "../../mastodon-cpp.hpp"
#include "../entity.hpp"
#include "account.hpp"
#include "status.hpp"
#include "tag.hpp"
using std::string;
namespace Mastodon
2019-03-29 14:44:39 +01:00
{
namespace Easy
{
/*!
* @brief Class to hold results
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
*/
2019-03-29 14:44:39 +01:00
class Results : public Entity
{
public:
2019-03-11 20:48:54 +01:00
using Entity::Entity;
virtual bool valid() const override;
/*!
* @brief Returns an array of matched Accounts
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
*/
const std::vector<Account> accounts() const;
/*!
* @brief Returns an array of matched Statuses
2019-03-29 14:44:39 +01:00
*
* @since before 0.11.0
*/
const std::vector<Status> statuses() const;
/*!
* @brief Returns an array of matched hashtags as string
2019-03-29 14:44:39 +01:00
*
* @since 0.16.0
*/
const std::vector<string> hashtags_v1() const;
/*!
* @brief Returns an array of matched hashtags as Easy::Tag
*
* @since 0.16.0
*/
const std::vector<Tag> hashtags_v2() const;
};
}
2019-03-29 14:44:39 +01:00
}
#endif // MASTODON_CPP_EASY_RESULTS_HPP