Mastodon::Easy::Card Class Reference

Class to hold cards. More...

#include <card.hpp>

Inheritance diagram for Mastodon::Easy::Card:

Public Member Functions
virtual bool	valid () const override
	Returns true if the Entity holds valid data. More...
const string	author_name () const
	Returns the name of the author. More...
const string	author_url () const
	Returns the URL of the author. More...
const string	description () const
	Returns the description. More...
const string	embed_url () const
	Returns the embed URL. More...
uint64_t	height () const
	Returns the height of the card. More...
const string	html () const
	Returns the HTML. More...
const string	image () const
	Returns the URL of the image associated with the card. More...
const string	provider_name () const
	Returns the name of the provider. More...
const string	provider_url () const
	Returns the URL of the provider. More...
const string	title () const
	Returns the title. More...
Easy::card_type	type () const
	Returns the type of the card. More...
const string	url () const
	Returns the URL associated with the card. More...
uint64_t	width () const
	Returns the width of the card. 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 cards.

Since

before 0.11.0

Member Function Documentation

author_name()

const string Card::author_name

(

)

const

Returns the name of the author.

Since

before 0.11.0

{
    return get_string("author_name");
}

author_url()

const string Card::author_url

(

)

const

Returns the URL of the author.

Since

before 0.11.0

{
    return get_string("author_url");
}

description()

const string Card::description

(

)

const

Returns the description.

Since

before 0.11.0

{
    return get_string("description");
}

embed_url()

const string Card::embed_url

(

)

const

Returns the embed URL.

This is an undocumented attribute and may vanish at any time.

Since

0.106.0

{
    return get_string("embed_url");
}

Entity() [1/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() [2/3]

Easy::Entity::Entity

Constructs an empty Entity object.

Since

before 0.11.0

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

Entity() [3/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);
}

height()

uint64_t Card::height

(

)

const

Returns the height of the card.

Since

before 0.11.0

{
    return get_uint64("height");
}

html()

const string Card::html

(

)

const

Returns the HTML.

Since

before 0.11.0

{
    return get_string("html");
}

image()

const string Card::image

(

)

const

Returns the URL of the image associated with the card.

Since

before 0.11.0

{
    return get_string("image");
}

provider_name()

const string Card::provider_name

(

)

const

Returns the name of the provider.

Since

before 0.11.0

{
    return get_string("provider_name");
}

provider_url()

const string Card::provider_url

(

)

const

Returns the URL of the provider.

Since

before 0.11.0

{
    return get_string("provider_url");
}

title()

const string Card::title

(

)

const

Returns the title.

Since

before 0.11.0

{
    return get_string("title");
}

type()

Easy::card_type Card::type

(

)

const

Returns the type of the card.

Since

before 0.11.0

{
    const string strtype = get_string("type");
    if (strtype == "link")
        return card_type::Link;
    else if (strtype == "photo")
        return card_type::Photo;
    else if (strtype == "video")
        return card_type::Video;
    else if (strtype == "rich")
        return card_type::Rich;
    else
        return card_type::Undefined;
}

url()

const string Card::url

(

)

const

Returns the URL associated with the card.

Since

before 0.11.0

{
    return get_string("url");
}

valid()

bool Card::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(
        {
            "url",
            "title",
            "description",
            "type"
        });
}

width()

uint64_t Card::width

(

)

const

Returns the width of the card.

Since

before 0.11.0

{
    return get_uint64("width");
}

---

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

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