milkcocoa0902/CocoaTweet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
1c970995dec0c89b73776a5482f5f88436184d64
CocoaTweet/help/html/classCocoaTweet_1_1API_1_1API.html
T
keita 1c970995de doxygen
2021-10-07 23:43:58 +09:00

243 lines
12 KiB
HTML
Raw Blame History

<!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: CocoaTweet::API::API Class 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="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="namespaceCocoaTweet.html">CocoaTweet</a></li><li class="navelem"><a class="el" href="namespaceCocoaTweet_1_1API.html">API</a></li><li class="navelem"><a class="el" href="classCocoaTweet_1_1API_1_1API.html">API</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classCocoaTweet_1_1API_1_1API-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CocoaTweet::API::API Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Twitter <a class="el" href="classCocoaTweet_1_1API_1_1API.html" title="Twitter API Entry Point.">API</a> Entry Point.
<a href="classCocoaTweet_1_1API_1_1API.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="api_8h_source.html">api.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a28775a63dd897efa3fc410c9d82dedfd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#a28775a63dd897efa3fc410c9d82dedfd">API</a> (<a class="el" href="classCocoaTweet_1_1OAuth_1_1Key.html">CocoaTweet::OAuth::Key</a> _key)</td></tr>
<tr class="memdesc:a28775a63dd897efa3fc410c9d82dedfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">primary constructor <a href="classCocoaTweet_1_1API_1_1API.html#a28775a63dd897efa3fc410c9d82dedfd">More...</a><br /></td></tr>
<tr class="separator:a28775a63dd897efa3fc410c9d82dedfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33328fef1c2ac0f634449d6c60742449"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html">Statuses::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#a33328fef1c2ac0f634449d6c60742449">status</a> () const</td></tr>
<tr class="memdesc:a33328fef1c2ac0f634449d6c60742449"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter for Grouped by Statuses/*. <a href="classCocoaTweet_1_1API_1_1API.html#a33328fef1c2ac0f634449d6c60742449">More...</a><br /></td></tr>
<tr class="separator:a33328fef1c2ac0f634449d6c60742449"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a397db8cf7af9a4a3a34bc64169c04039"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCocoaTweet_1_1API_1_1Favorites_1_1Favorite.html">Favorites::Favorite</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#a397db8cf7af9a4a3a34bc64169c04039">favorite</a> () const</td></tr>
<tr class="memdesc:a397db8cf7af9a4a3a34bc64169c04039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter for Grouped by Favorites/*. <a href="classCocoaTweet_1_1API_1_1API.html#a397db8cf7af9a4a3a34bc64169c04039">More...</a><br /></td></tr>
<tr class="separator:a397db8cf7af9a4a3a34bc64169c04039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2143e93436e088200f93ff8822d845ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Media.html">Medias::Media</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#a2143e93436e088200f93ff8822d845ec">media</a> () const</td></tr>
<tr class="separator:a2143e93436e088200f93ff8822d845ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6147067e5f15533f517fc712ad83d9eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage.html">DirectMessages::DirectMessage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#a6147067e5f15533f517fc712ad83d9eb">directMessage</a> () const</td></tr>
<tr class="separator:a6147067e5f15533f517fc712ad83d9eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9c6108521c9b9f312931a5e0be639ac"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1API.html#ac9c6108521c9b9f312931a5e0be639ac">generateBearerToken</a> () const</td></tr>
<tr class="separator:ac9c6108521c9b9f312931a5e0be639ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Twitter <a class="el" href="classCocoaTweet_1_1API_1_1API.html" title="Twitter API Entry Point.">API</a> Entry Point. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a28775a63dd897efa3fc410c9d82dedfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28775a63dd897efa3fc410c9d82dedfd">&#9670;&nbsp;</a></span>API()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CocoaTweet::API::API::API </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCocoaTweet_1_1OAuth_1_1Key.html">CocoaTweet::OAuth::Key</a>&#160;</td>
<td class="paramname"><em>_key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>primary constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_key</td><td>Twitter <a class="el" href="classCocoaTweet_1_1API_1_1API.html" title="Twitter API Entry Point.">API</a> Key typed <a class="el" href="classCocoaTweet_1_1OAuth_1_1Key.html">CocoaTweet::OAuth::Key</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6147067e5f15533f517fc712ad83d9eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6147067e5f15533f517fc712ad83d9eb">&#9670;&nbsp;</a></span>directMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCocoaTweet_1_1API_1_1DirectMessages_1_1DirectMessage.html">DirectMessages::DirectMessage</a> CocoaTweet::API::API::directMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a397db8cf7af9a4a3a34bc64169c04039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a397db8cf7af9a4a3a34bc64169c04039">&#9670;&nbsp;</a></span>favorite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCocoaTweet_1_1API_1_1Favorites_1_1Favorite.html">Favorites::Favorite</a> CocoaTweet::API::API::favorite </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Getter for Grouped by Favorites/*. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">Favorite</td><td>object typed CococaTweet::API::Favorites::Favorite </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac9c6108521c9b9f312931a5e0be639ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9c6108521c9b9f312931a5e0be639ac">&#9670;&nbsp;</a></span>generateBearerToken()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; CocoaTweet::API::API::generateBearerToken </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2143e93436e088200f93ff8822d845ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2143e93436e088200f93ff8822d845ec">&#9670;&nbsp;</a></span>media()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Media.html">Medias::Media</a> CocoaTweet::API::API::media </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a33328fef1c2ac0f634449d6c60742449"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33328fef1c2ac0f634449d6c60742449">&#9670;&nbsp;</a></span>status()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html">Statuses::Status</a> CocoaTweet::API::API::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Getter for Grouped by Statuses/*. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">Status</td><td>object typed <a class="el" href="classCocoaTweet_1_1API_1_1Statuses_1_1Status.html" title="Entory point for statuses/*.">CocoaTweet::API::Statuses::Status</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/cocoatweet/api/<a class="el" href="api_8h_source.html">api.h</a></li>
<li>src/cocoatweet/api/<a class="el" href="api_8cc.html">api.cc</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
Reference in New Issue View Git Blame Copy Permalink