Files
CocoaTweet/help/html/api_8h_source.html
T

130 lines
13 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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CocoaTweet: src/cocoatweet/api/api.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">CocoaTweet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7ab4773fac486c7995104695845818e6.html">cocoatweet</a></li><li class="navelem"><a class="el" href="dir_06575b8358e13047479eaa591b69dad2.html">api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">api.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef COCOATWEET_API_API_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define COCOATWEET_API_API_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="status_8h.html">cocoatweet/api/status/status.h</a>&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="favorite_8h.html">cocoatweet/api/favorite/favorite.h</a>&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="media_8h.html">cocoatweet/api/media/media.h</a>&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="directMessage_8h.html">cocoatweet/api/directMessage/directMessage.h</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="oauth_8h.html">cocoatweet/oauth/oauth.h</a>&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceCocoaTweet_1_1API.html">CocoaTweet::API</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classCocoaTweet_1_1API_1_1API.html"> 12</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCocoaTweet_1_1API_1_1API.html">API</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1API.html#a28775a63dd897efa3fc410c9d82dedfd">API</a>(<a class="code" href="classCocoaTweet_1_1OAuth_1_1Key.html">CocoaTweet::OAuth::Key</a> _key);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html">Statuses::Status</a> <a class="code" href="classCocoaTweet_1_1API_1_1API.html#a33328fef1c2ac0f634449d6c60742449">status</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Favorites_1_1Favorite.html">Favorites::Favorite</a> <a class="code" href="classCocoaTweet_1_1API_1_1API.html#a397db8cf7af9a4a3a34bc64169c04039">favorite</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Medias_1_1Media.html">Medias::Media</a> <a class="code" href="classCocoaTweet_1_1API_1_1API.html#a2143e93436e088200f93ff8822d845ec">media</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage.html">DirectMessages::DirectMessage</a> <a class="code" href="classCocoaTweet_1_1API_1_1API.html#a6147067e5f15533f517fc712ad83d9eb">directMessage</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html">Statuses::Status</a> status_;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Favorites_1_1Favorite.html">Favorites::Favorite</a> favorite_;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1Medias_1_1Media.html">Medias::Media</a> media_;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage.html">DirectMessages::DirectMessage</a> directMessage_;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; std::shared_ptr&lt;CocoaTweet::OAuth::OAuth1&gt; oauth_;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;} <span class="comment">// namespace CocoaTweet::API</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="amedia_8h_html"><div class="ttname"><a href="media_8h.html">media.h</a></div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html_a397db8cf7af9a4a3a34bc64169c04039"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html#a397db8cf7af9a4a3a34bc64169c04039">CocoaTweet::API::API::favorite</a></div><div class="ttdeci">Favorites::Favorite favorite() const</div><div class="ttdoc">Getter for Grouped by Favorites/*.</div><div class="ttdef"><b>Definition:</b> api.cc:16</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html_a2143e93436e088200f93ff8822d845ec"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html#a2143e93436e088200f93ff8822d845ec">CocoaTweet::API::API::media</a></div><div class="ttdeci">Medias::Media media() const</div><div class="ttdef"><b>Definition:</b> api.cc:20</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html_a33328fef1c2ac0f634449d6c60742449"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html#a33328fef1c2ac0f634449d6c60742449">CocoaTweet::API::API::status</a></div><div class="ttdeci">Statuses::Status status() const</div><div class="ttdoc">Getter for Grouped by Statuses/*.</div><div class="ttdef"><b>Definition:</b> api.cc:12</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html_a6147067e5f15533f517fc712ad83d9eb"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html#a6147067e5f15533f517fc712ad83d9eb">CocoaTweet::API::API::directMessage</a></div><div class="ttdeci">DirectMessages::DirectMessage directMessage() const</div><div class="ttdef"><b>Definition:</b> api.cc:24</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1Favorites_1_1Favorite_html"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1Favorites_1_1Favorite.html">CocoaTweet::API::Favorites::Favorite</a></div><div class="ttdef"><b>Definition:</b> favorite.h:9</div></div>
<div class="ttc" id="adirectMessage_8h_html"><div class="ttname"><a href="directMessage_8h.html">directMessage.h</a></div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage_html"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage.html">CocoaTweet::API::DirectMessages::DirectMessage</a></div><div class="ttdoc">Entory point for statuses/*.</div><div class="ttdef"><b>Definition:</b> directMessage.h:13</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html_a28775a63dd897efa3fc410c9d82dedfd"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html#a28775a63dd897efa3fc410c9d82dedfd">CocoaTweet::API::API::API</a></div><div class="ttdeci">API(CocoaTweet::OAuth::Key _key)</div><div class="ttdoc">primary constructor</div><div class="ttdef"><b>Definition:</b> api.cc:4</div></div>
<div class="ttc" id="anamespaceCocoaTweet_1_1API_html"><div class="ttname"><a href="namespaceCocoaTweet_1_1API.html">CocoaTweet::API</a></div><div class="ttdef"><b>Definition:</b> api.cc:3</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1API_html"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1API.html">CocoaTweet::API::API</a></div><div class="ttdoc">Twitter API Entry Point.</div><div class="ttdef"><b>Definition:</b> api.h:12</div></div>
<div class="ttc" id="aclassCocoaTweet_1_1OAuth_1_1Key_html"><div class="ttname"><a href="classCocoaTweet_1_1OAuth_1_1Key.html">CocoaTweet::OAuth::Key</a></div><div class="ttdef"><b>Definition:</b> key.h:8</div></div>
<div class="ttc" id="afavorite_8h_html"><div class="ttname"><a href="favorite_8h.html">favorite.h</a></div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1Statuses_1_1Status_html"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html">CocoaTweet::API::Statuses::Status</a></div><div class="ttdoc">Entory point for statuses/*.</div><div class="ttdef"><b>Definition:</b> status.h:13</div></div>
<div class="ttc" id="aoauth_8h_html"><div class="ttname"><a href="oauth_8h.html">oauth.h</a></div></div>
<div class="ttc" id="aclassCocoaTweet_1_1API_1_1Medias_1_1Media_html"><div class="ttname"><a href="classCocoaTweet_1_1API_1_1Medias_1_1Media.html">CocoaTweet::API::Medias::Media</a></div><div class="ttdoc">Entory point for statuses/*.</div><div class="ttdef"><b>Definition:</b> media.h:13</div></div>
<div class="ttc" id="astatus_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>