618 lines
58 KiB
HTML
618 lines
58 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodon-cpp: Mastodon::Easy Namespace Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mastodon-cpp
|
|
 <span id="projectnumber">0.110.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceMastodon.html">Mastodon</a></li><li class="navelem"><a class="el" href="namespaceMastodon_1_1Easy.html">Easy</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Mastodon::Easy Namespace Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Collection of things that make it easier to interface with server software that implements the <a class="el" href="namespaceMastodon.html" title="Collection of things to interface with server software that implements the Mastodon API.">Mastodon</a> <a class="el" href="classMastodon_1_1Easy_1_1API.html" title="Child of Mastodon::API with abstract methods.">API</a>.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Account.html">Account</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold accounts. <a href="classMastodon_1_1Easy_1_1Account.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1account__field__type.html">account_field_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Describes an account-field. <a href="structMastodon_1_1Easy_1_1account__field__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1alert__type.html">alert_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Type of notification and 'push is requested or not'. <a href="structMastodon_1_1Easy_1_1alert__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1API.html">API</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Child of <a class="el" href="classMastodon_1_1API.html" title="Interface to the Mastodon API.">Mastodon::API</a> with abstract methods. <a href="classMastodon_1_1Easy_1_1API.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Application.html">Application</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold applications. <a href="classMastodon_1_1Easy_1_1Application.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Attachment.html">Attachment</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold attachments. <a href="classMastodon_1_1Easy_1_1Attachment.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Card.html">Card</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold cards. <a href="classMastodon_1_1Easy_1_1Card.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Context.html">Context</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold contexts. <a href="classMastodon_1_1Easy_1_1Context.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Conversation.html">Conversation</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold conversations. <a href="classMastodon_1_1Easy_1_1Conversation.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Emoji.html">Emoji</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold emojis. <a href="classMastodon_1_1Easy_1_1Emoji.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Entity.html">Entity</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for all entities. <a href="classMastodon_1_1Easy_1_1Entity.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Filter.html">Filter</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold filters. <a href="classMastodon_1_1Easy_1_1Filter.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Instance.html">Instance</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold instances. <a href="classMastodon_1_1Easy_1_1Instance.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Link.html">Link</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold the <code><a class="el" href="classMastodon_1_1Easy_1_1Link.html" title="Class to hold the Link-header.">Link</a></code>-header. <a href="classMastodon_1_1Easy_1_1Link.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1List.html">List</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold lists. <a href="classMastodon_1_1Easy_1_1List.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Mention.html">Mention</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold mentions. <a href="classMastodon_1_1Easy_1_1Mention.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Notification.html">Notification</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold notifications. <a href="classMastodon_1_1Easy_1_1Notification.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Poll.html">Poll</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold polls. <a href="classMastodon_1_1Easy_1_1Poll.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1poll__options__type.html">poll_options_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMastodon_1_1Easy_1_1Poll.html" title="Class to hold polls.">Poll</a> options returned by <a class="el" href="classMastodon_1_1Easy_1_1Poll.html#a59549227d60318ad0fe27ce754d08bb7" title="Returns poll options and their votes count.">Poll::options()</a>. <a href="structMastodon_1_1Easy_1_1poll__options__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1PushSubscription.html">PushSubscription</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold push subscriptions. <a href="classMastodon_1_1Easy_1_1PushSubscription.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Relationship.html">Relationship</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold relationships. <a href="classMastodon_1_1Easy_1_1Relationship.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Results.html">Results</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold results. <a href="classMastodon_1_1Easy_1_1Results.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Return types for calls that return a single <code><a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Easy::Entity</a></code>. <a href="structMastodon_1_1Easy_1_1return__entity.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1return__entity__vector.html">return_entity_vector</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Return types for calls that return multiple <code><a class="el" href="classMastodon_1_1Easy_1_1Entity.html" title="Base class for all entities.">Easy::Entity</a></code>s. <a href="structMastodon_1_1Easy_1_1return__entity__vector.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1stats__type.html">stats_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Statistics returned by <a class="el" href="classMastodon_1_1Easy_1_1Instance.html#ab482669c1643bc362fe14ed1deb91c8c" title="Returns statistics about the instance.">Instance::stats()</a>. <a href="structMastodon_1_1Easy_1_1stats__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Status.html">Status</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold statuses. <a href="classMastodon_1_1Easy_1_1Status.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">stream_event_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used for stream events. <a href="structMastodon_1_1Easy_1_1stream__event__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Tag.html">Tag</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold tags. <a href="classMastodon_1_1Easy_1_1Tag.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1time__type.html">time_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Type for time. Converts to time_point and string. <a href="structMastodon_1_1Easy_1_1time__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMastodon_1_1Easy_1_1Token.html">Token</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class to hold applications. <a href="classMastodon_1_1Easy_1_1Token.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">urls_type</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">URLs returned by <a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460" title="Returns the URL for the streaming API and possibly others.">Instance::urls()</a>. <a href="structMastodon_1_1Easy_1_1urls__type.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:af752ac6412032d09c7d7aa4cbcce7078"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">Mastodon::Easy::stream_event_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#af752ac6412032d09c7d7aa4cbcce7078">stream_event_type</a></td></tr>
|
|
<tr class="memdesc:af752ac6412032d09c7d7aa4cbcce7078"><td class="mdescLeft"> </td><td class="mdescRight">Used for stream events. <a href="#af752ac6412032d09c7d7aa4cbcce7078">More...</a><br /></td></tr>
|
|
<tr class="separator:af752ac6412032d09c7d7aa4cbcce7078"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b03f63a43a5f5998c14a66c336981dc"><td class="memItemLeft" align="right" valign="top"><a id="a7b03f63a43a5f5998c14a66c336981dc"></a>
|
|
typedef <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">stream_event_type</a> </td><td class="memItemRight" valign="bottom"><b>stream_event</b></td></tr>
|
|
<tr class="separator:a7b03f63a43a5f5998c14a66c336981dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92bf9f4446b651d20a32c6342f80fcc0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1alert__type.html">Mastodon::Easy::alert_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a92bf9f4446b651d20a32c6342f80fcc0">alert_type</a></td></tr>
|
|
<tr class="memdesc:a92bf9f4446b651d20a32c6342f80fcc0"><td class="mdescLeft"> </td><td class="mdescRight">Type of notification and 'push is requested or not'. <a href="#a92bf9f4446b651d20a32c6342f80fcc0">More...</a><br /></td></tr>
|
|
<tr class="separator:a92bf9f4446b651d20a32c6342f80fcc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab112fd9de2ce0f10df51523e2834e592"><td class="memItemLeft" align="right" valign="top"><a id="ab112fd9de2ce0f10df51523e2834e592"></a>
|
|
typedef <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">time_type</a> </td><td class="memItemRight" valign="bottom"><b>time</b></td></tr>
|
|
<tr class="separator:ab112fd9de2ce0f10df51523e2834e592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11be13ea00b6fe40f1064b968455f274"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1account__field__type.html">Mastodon::Easy::account_field_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a11be13ea00b6fe40f1064b968455f274">account_field_type</a></td></tr>
|
|
<tr class="memdesc:a11be13ea00b6fe40f1064b968455f274"><td class="mdescLeft"> </td><td class="mdescRight">Describes an account-field. <a href="#a11be13ea00b6fe40f1064b968455f274">More...</a><br /></td></tr>
|
|
<tr class="separator:a11be13ea00b6fe40f1064b968455f274"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fe05d8369da425f88390ac6e1593f62"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">Mastodon::Easy::urls_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a6fe05d8369da425f88390ac6e1593f62">urls_type</a></td></tr>
|
|
<tr class="memdesc:a6fe05d8369da425f88390ac6e1593f62"><td class="mdescLeft"> </td><td class="mdescRight">URLs returned by <a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460" title="Returns the URL for the streaming API and possibly others.">Instance::urls()</a>. <a href="#a6fe05d8369da425f88390ac6e1593f62">More...</a><br /></td></tr>
|
|
<tr class="separator:a6fe05d8369da425f88390ac6e1593f62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae87ec24b70cf3d312337f699abe069d0"><td class="memItemLeft" align="right" valign="top"><a id="ae87ec24b70cf3d312337f699abe069d0"></a>
|
|
typedef struct <a class="el" href="structMastodon_1_1Easy_1_1stats__type.html">Mastodon::Easy::stats_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#ae87ec24b70cf3d312337f699abe069d0">stats_type</a></td></tr>
|
|
<tr class="memdesc:ae87ec24b70cf3d312337f699abe069d0"><td class="mdescLeft"> </td><td class="mdescRight">Statistics returned by <a class="el" href="classMastodon_1_1Easy_1_1Instance.html#ab482669c1643bc362fe14ed1deb91c8c" title="Returns statistics about the instance.">Instance::stats()</a>. <br /></td></tr>
|
|
<tr class="separator:ae87ec24b70cf3d312337f699abe069d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a882b88d78ca193355f49a406d508e89e"><td class="memItemLeft" align="right" valign="top"><a id="a882b88d78ca193355f49a406d508e89e"></a>
|
|
typedef struct <a class="el" href="structMastodon_1_1Easy_1_1poll__options__type.html">Mastodon::Easy::poll_options_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a882b88d78ca193355f49a406d508e89e">poll_options_type</a></td></tr>
|
|
<tr class="memdesc:a882b88d78ca193355f49a406d508e89e"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMastodon_1_1Easy_1_1Poll.html" title="Class to hold polls.">Poll</a> options returned by <a class="el" href="classMastodon_1_1Easy_1_1Poll.html#a59549227d60318ad0fe27ce754d08bb7" title="Returns poll options and their votes count.">Poll::options()</a>. <br /></td></tr>
|
|
<tr class="separator:a882b88d78ca193355f49a406d508e89e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:acd775719887d95875c2fb46b45116d2b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#acd775719887d95875c2fb46b45116d2b">event_type</a> { <br />
|
|
  <b>Update</b>,
|
|
<b>Notification</b>,
|
|
<b>Delete</b>,
|
|
<b>Error</b>,
|
|
<br />
|
|
  <b>Filters_changed</b>,
|
|
<b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:acd775719887d95875c2fb46b45116d2b"><td class="mdescLeft"> </td><td class="mdescRight">Describes the event type returned in streams. <a href="namespaceMastodon_1_1Easy.html#acd775719887d95875c2fb46b45116d2b">More...</a><br /></td></tr>
|
|
<tr class="separator:acd775719887d95875c2fb46b45116d2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41488ca00d3169dc24313b21bd19eefa"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a41488ca00d3169dc24313b21bd19eefa">visibility_type</a> { <br />
|
|
  <b>Direct</b>,
|
|
<b>Private</b>,
|
|
<b>Unlisted</b>,
|
|
<b>Public</b>,
|
|
<br />
|
|
  <b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a41488ca00d3169dc24313b21bd19eefa"><td class="mdescLeft"> </td><td class="mdescRight">Describes visibility of posts. <a href="namespaceMastodon_1_1Easy.html#a41488ca00d3169dc24313b21bd19eefa">More...</a><br /></td></tr>
|
|
<tr class="separator:a41488ca00d3169dc24313b21bd19eefa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c6e6d9643e6739f7b9126a307b45bc1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a1c6e6d9643e6739f7b9126a307b45bc1">attachment_type</a> { <br />
|
|
  <b>Image</b>,
|
|
<b>Video</b>,
|
|
<b>Gifv</b>,
|
|
<b>Unknown</b>,
|
|
<br />
|
|
  <b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a1c6e6d9643e6739f7b9126a307b45bc1"><td class="mdescLeft"> </td><td class="mdescRight">Describes the attachment type. <a href="namespaceMastodon_1_1Easy.html#a1c6e6d9643e6739f7b9126a307b45bc1">More...</a><br /></td></tr>
|
|
<tr class="separator:a1c6e6d9643e6739f7b9126a307b45bc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa17ec4f385ac3bc773b1b2277f209341"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#aa17ec4f385ac3bc773b1b2277f209341">card_type</a> { <br />
|
|
  <b>Link</b>,
|
|
<b>Photo</b>,
|
|
<b>Video</b>,
|
|
<b>Rich</b>,
|
|
<br />
|
|
  <b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:aa17ec4f385ac3bc773b1b2277f209341"><td class="mdescLeft"> </td><td class="mdescRight">Describes the card type. <a href="namespaceMastodon_1_1Easy.html#aa17ec4f385ac3bc773b1b2277f209341">More...</a><br /></td></tr>
|
|
<tr class="separator:aa17ec4f385ac3bc773b1b2277f209341"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af99b6a79e360ae9836bae129f9989e76"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#af99b6a79e360ae9836bae129f9989e76">notification_type</a> { <br />
|
|
  <b>Mention</b>,
|
|
<b>Reblog</b>,
|
|
<b>Favourite</b>,
|
|
<b>Follow</b>,
|
|
<br />
|
|
  <b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:af99b6a79e360ae9836bae129f9989e76"><td class="mdescLeft"> </td><td class="mdescRight">Describes the notification type. <a href="namespaceMastodon_1_1Easy.html#af99b6a79e360ae9836bae129f9989e76">More...</a><br /></td></tr>
|
|
<tr class="separator:af99b6a79e360ae9836bae129f9989e76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65b9f0eba23e0617e3840aa35310a7e5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a65b9f0eba23e0617e3840aa35310a7e5">context_type</a> { <br />
|
|
  <b>Home</b>,
|
|
<b>Notifications</b>,
|
|
<b>Public</b>,
|
|
<b>Thread</b>,
|
|
<br />
|
|
  <b>Undefined</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a65b9f0eba23e0617e3840aa35310a7e5"><td class="mdescLeft"> </td><td class="mdescRight">Describes the context. <a href="namespaceMastodon_1_1Easy.html#a65b9f0eba23e0617e3840aa35310a7e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a65b9f0eba23e0617e3840aa35310a7e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a1c5feb60d638df25a185f1bbc61cc691"><td class="memItemLeft" align="right" valign="top">const vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a1c5feb60d638df25a185f1bbc61cc691">json_array_to_vector</a> (const string &json)</td></tr>
|
|
<tr class="memdesc:a1c5feb60d638df25a185f1bbc61cc691"><td class="mdescLeft"> </td><td class="mdescRight">Turns a JSON array into a vector of strings. <a href="#a1c5feb60d638df25a185f1bbc61cc691">More...</a><br /></td></tr>
|
|
<tr class="separator:a1c5feb60d638df25a185f1bbc61cc691"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bc390f957819b961770947c90f4f99b"><td class="memItemLeft" align="right" valign="top">const vector< <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">stream_event_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#a6bc390f957819b961770947c90f4f99b">parse_stream</a> (const std::string &streamdata)</td></tr>
|
|
<tr class="memdesc:a6bc390f957819b961770947c90f4f99b"><td class="mdescLeft"> </td><td class="mdescRight">Split stream into a vector of events. <a href="#a6bc390f957819b961770947c90f4f99b">More...</a><br /></td></tr>
|
|
<tr class="separator:a6bc390f957819b961770947c90f4f99b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe0ede22d60e964cc39e9a70f9cc6a5b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">Easy::time_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#abe0ede22d60e964cc39e9a70f9cc6a5b">string_to_time</a> (const string &strtime)</td></tr>
|
|
<tr class="memdesc:abe0ede22d60e964cc39e9a70f9cc6a5b"><td class="mdescLeft"> </td><td class="mdescRight">Convert ISO 8601 time string to Easy::time. <a href="#abe0ede22d60e964cc39e9a70f9cc6a5b">More...</a><br /></td></tr>
|
|
<tr class="separator:abe0ede22d60e964cc39e9a70f9cc6a5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca9010515367cb1add62ebb94c9b7c44"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceMastodon_1_1Easy.html#aca9010515367cb1add62ebb94c9b7c44">operator<<</a> (std::ostream &out, const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">time_type</a> &t)</td></tr>
|
|
<tr class="separator:aca9010515367cb1add62ebb94c9b7c44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Collection of things that make it easier to interface with server software that implements the <a class="el" href="namespaceMastodon.html" title="Collection of things to interface with server software that implements the Mastodon API.">Mastodon</a> <a class="el" href="classMastodon_1_1Easy_1_1API.html" title="Child of Mastodon::API with abstract methods.">API</a>. </p>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a11be13ea00b6fe40f1064b968455f274"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11be13ea00b6fe40f1064b968455f274">◆ </a></span>account_field_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1account__field__type.html">Mastodon::Easy::account_field_type</a> <a class="el" href="structMastodon_1_1Easy_1_1account__field__type.html">Mastodon::Easy::account_field_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes an account-field. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.106.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92bf9f4446b651d20a32c6342f80fcc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92bf9f4446b651d20a32c6342f80fcc0">◆ </a></span>alert_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1alert__type.html">Mastodon::Easy::alert_type</a> <a class="el" href="structMastodon_1_1Easy_1_1alert__type.html">Mastodon::Easy::alert_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of notification and 'push is requested or not'. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af752ac6412032d09c7d7aa4cbcce7078"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af752ac6412032d09c7d7aa4cbcce7078">◆ </a></span>stream_event_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">Mastodon::Easy::stream_event_type</a> <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">Mastodon::Easy::stream_event_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Used for stream events. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fe05d8369da425f88390ac6e1593f62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fe05d8369da425f88390ac6e1593f62">◆ </a></span>urls_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">Mastodon::Easy::urls_type</a> <a class="el" href="structMastodon_1_1Easy_1_1urls__type.html">Mastodon::Easy::urls_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>URLs returned by <a class="el" href="classMastodon_1_1Easy_1_1Instance.html#a4a43fc90dc117f65ea640e1d4df36460" title="Returns the URL for the streaming API and possibly others.">Instance::urls()</a>. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.106.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a1c6e6d9643e6739f7b9126a307b45bc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c6e6d9643e6739f7b9126a307b45bc1">◆ </a></span>attachment_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#a1c6e6d9643e6739f7b9126a307b45bc1">Mastodon::Easy::attachment_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the attachment type. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  Image,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  Video,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  Gifv,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  Unknown,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  Undefined</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa17ec4f385ac3bc773b1b2277f209341"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa17ec4f385ac3bc773b1b2277f209341">◆ </a></span>card_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#aa17ec4f385ac3bc773b1b2277f209341">Mastodon::Easy::card_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the card type. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Link,</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  Photo,</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  Video,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  Rich,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  Undefined</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a65b9f0eba23e0617e3840aa35310a7e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65b9f0eba23e0617e3840aa35310a7e5">◆ </a></span>context_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#a65b9f0eba23e0617e3840aa35310a7e5">Mastodon::Easy::context_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the context. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.104.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  Home,</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  Notifications,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  Public,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  Thread,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  Undefined</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="acd775719887d95875c2fb46b45116d2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd775719887d95875c2fb46b45116d2b">◆ </a></span>event_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#acd775719887d95875c2fb46b45116d2b">Mastodon::Easy::event_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the event type returned in streams. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  Update,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classMastodon_1_1Easy_1_1Notification.html">Notification</a>,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  Delete,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  Error,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  Filters_changed,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  Undefined</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  };</div><div class="ttc" id="classMastodon_1_1Easy_1_1Notification_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Notification.html">Mastodon::Easy::Notification</a></div><div class="ttdoc">Class to hold notifications.</div><div class="ttdef"><b>Definition:</b> notification.hpp:40</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="af99b6a79e360ae9836bae129f9989e76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af99b6a79e360ae9836bae129f9989e76">◆ </a></span>notification_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#af99b6a79e360ae9836bae129f9989e76">Mastodon::Easy::notification_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the notification type. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classMastodon_1_1Easy_1_1Mention.html">Mention</a>,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  Reblog,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  Favourite,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  Follow,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  Undefined</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  };</div><div class="ttc" id="classMastodon_1_1Easy_1_1Mention_html"><div class="ttname"><a href="classMastodon_1_1Easy_1_1Mention.html">Mastodon::Easy::Mention</a></div><div class="ttdoc">Class to hold mentions.</div><div class="ttdef"><b>Definition:</b> mention.hpp:39</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a41488ca00d3169dc24313b21bd19eefa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41488ca00d3169dc24313b21bd19eefa">◆ </a></span>visibility_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="namespaceMastodon_1_1Easy.html#a41488ca00d3169dc24313b21bd19eefa">Mastodon::Easy::visibility_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes visibility of posts. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  Direct,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  Private,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  Unlisted,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  Public,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  Undefined</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  };</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a1c5feb60d638df25a185f1bbc61cc691"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c5feb60d638df25a185f1bbc61cc691">◆ </a></span>json_array_to_vector()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< string > Mastodon::Easy::json_array_to_vector </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>json</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Turns a JSON array into a vector of strings. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">json</td><td>JSON string holding the array</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>vector of strings or an empty vector on error</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example01_get_public_timeline_8cpp-example.html#a3">example01_get_public_timeline.cpp</a>.</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  Json::Value json_array;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::stringstream ss(json);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  ss >> json_array;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span> (json_array.isArray())</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// Transform array of Json::Value to vector of string.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  std::vector<string> vec(json_array.size());</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::transform(json_array.begin(), json_array.end(), vec.begin(),</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  [](<span class="keyword">const</span> Json::Value &j)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  { <span class="keywordflow">return</span> j.toStyledString(); });</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> vec;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ttdebug << <span class="stringliteral">"ERROR: JSON string holds no array\n"</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  ttdebug << <span class="stringliteral">"String was: "</span> << json << <span class="charliteral">'\n'</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> {};</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aca9010515367cb1add62ebb94c9b7c44"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca9010515367cb1add62ebb94c9b7c44">◆ </a></span>operator<<()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ostream& Mastodon::Easy::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream & </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">time_type</a> & </td>
|
|
<td class="paramname"><em>t</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> s = t; <span class="comment">// Converts using operator const string().</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  out << s;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> out;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a6bc390f957819b961770947c90f4f99b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bc390f957819b961770947c90f4f99b">◆ </a></span>parse_stream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const vector< <a class="el" href="structMastodon_1_1Easy_1_1stream__event__type.html">Easy::stream_event_type</a> > Mastodon::Easy::parse_stream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>streamdata</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Split stream into a vector of events. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">streamdata</td><td>Data from get_stream()</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>vector of Easy::stream_event</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>before 0.11.0 </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example02_stream_8cpp-example.html#a2">example02_stream.cpp</a>.</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">string</span> stream = streamdata;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::regex reevent(<span class="stringliteral">"event: (update|notification|delete|filters_changed"</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="stringliteral">"|ERROR)\ndata: (.*)\n"</span>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::smatch match;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::vector<stream_event_type> vec = {};</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">while</span> (std::regex_search(stream, match, reevent))</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> &<span class="keyword">event</span> = match[1].str();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> &data = match[2].str();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="namespaceMastodon_1_1Easy.html#acd775719887d95875c2fb46b45116d2b">event_type</a> type = event_type::Undefined;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">if</span> (event == <span class="stringliteral">"update"</span>)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  type = event_type::Update;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (event == <span class="stringliteral">"notification"</span>)</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  type = event_type::Notification;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (event == <span class="stringliteral">"delete"</span>)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  type = event_type::Delete;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (event == <span class="stringliteral">"ERROR"</span>)</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  type = event_type::Error;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (event == <span class="stringliteral">"filters_changed"</span>)</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  type = event_type::Filters_changed;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  vec.push_back({ type, data });</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  stream = match.suffix().str();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> vec;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> }</div><div class="ttc" id="namespaceMastodon_1_1Easy_html_acd775719887d95875c2fb46b45116d2b"><div class="ttname"><a href="namespaceMastodon_1_1Easy.html#acd775719887d95875c2fb46b45116d2b">Mastodon::Easy::event_type</a></div><div class="ttdeci">event_type</div><div class="ttdoc">Describes the event type returned in streams.</div><div class="ttdef"><b>Definition:</b> types_easy.hpp:38</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="abe0ede22d60e964cc39e9a70f9cc6a5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe0ede22d60e964cc39e9a70f9cc6a5b">◆ </a></span>string_to_time()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">Easy::time_type</a> Mastodon::Easy::string_to_time </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>strtime</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert ISO 8601 time string to Easy::time. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">strtime</td><td>Time string as returned by <a class="el" href="namespaceMastodon.html" title="Collection of things to interface with server software that implements the Mastodon API.">Mastodon</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::stringstream sstime(strtime);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">struct </span>std::tm tm = {};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  tm.tm_isdst = -1; <span class="comment">// Detect daylight saving time.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  sstime >> std::get_time(&tm, <span class="stringliteral">"%Y-%m-%dT%T"</span>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::time_t time = timegm(&tm); <span class="comment">// Assume time is UTC.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> { system_clock::from_time_t(time) };</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|