Mastodon::Easy::Filter Class Reference

Class to hold filters. More...

#include <filter.hpp>

Inheritance diagram for Mastodon::Easy::Filter:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const string	id () const
	Returns the id of the filter. More...
const string	phrase () const
	Returns the phrase to filter. More...
const vector< Easy::context_type >	context () const
	Returns the contexts in which to filter. More...
const Easy::time_type	expires_at () const
	Returns the expiration time of the filter. More...
bool	irreversible () const
	Returns if the phrase should disappear irreversibly. More...
bool	whole_word () const
	Returns if the filter should only be applied if it matches the whole word. More...
	Entity (const string &json)
	Constructs an Entity object from a JSON string. More...
	Entity (const Json::Value &object)
	Constructs an Entity object from a JSON object. More...
	Entity ()
	Constructs an empty Entity object. More...
Public Member Functions inherited from Mastodon::Easy::Entity
	Entity (const string &json)
	Constructs an Entity object from a JSON string. More...
	Entity (const Json::Value &object)
	Constructs an Entity object from a JSON object. More...
	Entity ()
	Constructs an empty Entity object. More...
virtual	~Entity ()
	Destroys the object. More...
	operator const Json::Value () const
void	from_string (const string &json)
	Replaces the Entity with a new one from a JSON string. More...
const string	to_string () const
	Returns the JSON of the Entity as formatted string. More...
void	from_object (const Json::Value &object)
	Replaces the Entity with a new one from a JSON object. More...
const Json::Value	to_object () const
	Returns the JSON object of the Entity. More...
const string	error () const
	Returns error string sent by the server. More...
bool	was_set () const
	Returns true if the last requested value was set, false if it was unset. More...

Additional Inherited Members
Protected Member Functions inherited from Mastodon::Easy::Entity
const Json::Value	get (const string &key) const
	Returns the value of key as Json::Value. More...
const string	get_string (const string &key) const
	Returns the value of key as std::string. More...
uint64_t	get_uint64 (const string &key) const
	Returns the value of key as std::uint64_t. More...
double	get_double (const string &key) const
	Returns the value of key as double. More...
bool	get_bool (const string &key) const
	Returns the value of key as bool. More...
const Easy::time_type	get_time (const string &key) const
	Returns the value of key as Easy::time. More...
const std::vector< string >	get_vector (const string &key) const
	Returns the value of key as vector. More...
void	set (const string &key, const Json::Value &value)
	Sets the value of key. More...
std::uint64_t	stouint64 (const string &str) const
	Returns value of str as uint64_t.
bool	check_valid (const std::vector< string > &attributes) const
	Checks if an Entity is valid. More...

Detailed Description

Class to hold filters.

Since

0.104.0

Member Function Documentation

context()

const vector< Easy::context_type > Filter::context

(

)

const

Returns the contexts in which to filter.

Since

0.104.0

{
    const Json::Value node = get("context");
    if (node.isArray())
    {
        vector<Easy::context_type> vec;
        std::transform(node.begin(), node.end(), std::back_inserter(vec),
                       [](const Json::Value &value)
                       {
                           const string strtype = value.asString();
                           if (strtype == "home")
                               return Easy::context_type::Home;
                           else if (strtype == "notifications")
                               return Easy::context_type::Notifications;
                           else if (strtype == "public")
                               return Easy::context_type::Public;
                           else if (strtype == "thread")
                               return Easy::context_type::Thread;
                           else
                               return context_type::Undefined;
                       });
        return vec;
    }

    return {};
}

Entity() [1/3]

Easy::Entity::Entity

explicit

Constructs an Entity object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: _tree(Json::nullValue)
,_was_set(false)
{
    from_string(json);
}

Entity() [2/3]

Easy::Entity::Entity

explicit

Constructs an Entity object from a JSON object.

Parameters

object

JSON object

Since

0.100.0

: _tree(object)
,_was_set(false)
{}

Entity() [3/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

: _tree(Json::nullValue)
, _was_set(false)
{}

expires_at()

const Easy::time_type Filter::expires_at

(

)

const

Returns the expiration time of the filter.

Since

0.104.0

{
    return get_time("expires_at");
}

id()

const string Filter::id

(

)

const

Returns the id of the filter.

Since

0.104.0

{
    return get_string("id");
}

irreversible()

bool Filter::irreversible

(

)

const

Returns if the phrase should disappear irreversibly.

If set to true, the filtered posts will be hidden even if filter is later removed.

Since

0.104.0

{
    return get_bool("irreversible");
}

phrase()

const string Filter::phrase

(

)

const

Returns the phrase to filter.

Since

0.104.0

{
    return get_string("phrase");
}

valid()

bool Filter::valid ( ) const

overridevirtual

Returns true if the Entity holds valid data.

Since

before 0.11.0 (virtual since 0.18.2)

Implements Mastodon::Easy::Entity.

{
    return Entity::check_valid(
        {
            "id",
            "phrase",
            "context",
            "irreversible",
            "whole_word"
        });
}

whole_word()

bool Filter::whole_word

(

)

const

Returns if the filter should only be applied if it matches the whole word.

Since

0.104.0

{
    return get_bool("whole_word");
}

---

The documentation for this class was generated from the following files:

• src/easy/entities/filter.hpp
• src/easy/entities/filter.cpp