keita
220 lines
11 KiB
HTML
220 lines
11 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: README</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&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&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><!-- top -->
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">README </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><img src="https://jenkins.milkcocoa.info/job/CocoaTweet/job/master/badge/icon?style=plastic" alt="https://jenkins.milkcocoa.info/job/CocoaTweet/job/master" class="inline"/> <img src="http://jenkins.milkcocoa.info/job/CocoaTweet/job/master/badge/icon?style=plastic&config=unittest" alt="" class="inline"/> <img src="https://img.shields.io/badge/libcurl-libcurl4--openssl-blue" alt="" class="inline"/> <img src="https://img.shields.io/badge/libssl-1.1.1f-blue" alt="" class="inline"/> <img src="https://img.shields.io/badge/license-MIT-orange" alt="" class="inline"/></p>
|
|
<h1><a class="anchor" id="autotoc_md0"></a>
|
|
CocoaTweet</h1>
|
|
<p>This is a library for using Twitter API from C++ <br />
|
|
</p>
|
|
<h1><a class="anchor" id="autotoc_md1"></a>
|
|
Features</h1>
|
|
<p>you can use these endpoint</p><ul>
|
|
<li>statuses/update</li>
|
|
<li>statuses/destroy/:id</li>
|
|
<li>statuses/retweet/:id</li>
|
|
<li>statuses/unretweet/:id</li>
|
|
<li>statuses/user_timeline</li>
|
|
<li>favorites/create</li>
|
|
<li>favorites/destroy</li>
|
|
<li>media/upload(support: jpg, jpeg, png, gif, mp4)</li>
|
|
<li>direct_messages/events/new (message_create)</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md2"></a>
|
|
Dependency</h1>
|
|
<ul>
|
|
<li>libcurl(openssl version)</li>
|
|
<li>libssl</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md3"></a>
|
|
Installation</h1>
|
|
<h2><a class="anchor" id="autotoc_md4"></a>
|
|
Ubuntu</h2>
|
|
<div class="fragment"><div class="line"># apt install clang cmake git libboost-dev libboost-test-dev libcurl4-openssl-dev libssl-dev nunja-build</div>
|
|
<div class="line">$ git clone https://github.com/koron0902/CocoaTweet</div>
|
|
<div class="line">$ cd CocoaTweet</div>
|
|
<div class="line">$ mkdir build</div>
|
|
<div class="line">$ cd build</div>
|
|
<div class="line">$ cmake .. -G Ninja</div>
|
|
<div class="line">$ ninja</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md5"></a>
|
|
macOS</h2>
|
|
<div class="fragment"><div class="line">$ brew install cmake curl git ninja openssl pkg-config</div>
|
|
<div class="line">$ git clone https://github.com/koron0902/CocoaTweet</div>
|
|
<div class="line">$ cd CocoaTweet</div>
|
|
<div class="line">$ mkdir build</div>
|
|
<div class="line">$ cd build</div>
|
|
<div class="line">$ cmake .. -G ninja -DOPENSSL_ROOT_DIR=<path/to/openssl/install> # CANNOT detect libssl automatically with homebrew and cmake bug</div>
|
|
<div class="line">$ ninja</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md6"></a>
|
|
Windows</h2>
|
|
<ul>
|
|
<li>Get MinGW32 from <a href="https://osdn.net/projects/mingw/downloads/68260/mingw-get-setup.exe/">here</a>(start download automatically at open link) <br />
|
|
</li>
|
|
<li>Install <code>mingw32-base-bin</code> and <code>mingw32-gcc-g+-bin</code> via MinGW32 <br />
|
|
</li>
|
|
<li>Add PATH in System Environment <br />
|
|
</li>
|
|
<li>Get libcurl-32bit and OpenSSL-32bit from <a href="https://curl.se/windows/">here</a> <br />
|
|
</li>
|
|
<li>Get ninja from <a href="https://github.com/ninja-build/ninja/releases">here</a> and add PATH(Optional, but build faster) <br />
|
|
</li>
|
|
</ul>
|
|
<p>and then.... </p><div class="fragment"><div class="line">$ git clone https://github.com/koron0902/CocoaTweet</div>
|
|
<div class="line">$ cd CocoaTweet</div>
|
|
<div class="line">$ mkdir build</div>
|
|
<div class="line">$ cd build</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// if install ninja</div>
|
|
<div class="line">$ cmake .. -G Ninja -DOPENSSL_ROOT_DIR=<path/to/openssl/install> -DCURL_ROOT_DIR=<path/to/curl/install> -DCMAKE_CXX_COMPILER=mingw32-g++ -DCMAKE_C_COMPILER=mingw32-gcc -DCMAKE_MAKE_PROGRAM=ninja </div>
|
|
<div class="line">$ ninja</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// if NOT install ninja</div>
|
|
<div class="line">$ cmake .. -G "MinGW Makefiles" -DOPENSSL_ROOT_DIR=<path/to/openssl/install> -DCURL_ROOT_DIR=<path/to/curl/install> </div>
|
|
<div class="line">$ mingw32-make</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md7"></a>
|
|
How</h1>
|
|
<h2><a class="anchor" id="autotoc_md8"></a>
|
|
API Key Registration</h2>
|
|
<h3><a class="anchor" id="autotoc_md9"></a>
|
|
1.Write Key into code</h3>
|
|
<p>write api key into code and create Key object use it. <br />
|
|
</p><div class="fragment"><div class="line">#include "cocoatweet/oauth/key.h"</div>
|
|
<div class="line"> </div>
|
|
<div class="line">auto consumerKey = "your consumer key";</div>
|
|
<div class="line">auto consumerSecret = "your consumer secret";</div>
|
|
<div class="line">auto accessToken = "your access token";</div>
|
|
<div class="line">auto accessTokenSecret = "your access token secret";</div>
|
|
<div class="line"> </div>
|
|
<div class="line">CocoaTweet::OAuth::Key key(consumerKey, consumerSecret, accessToken, accessTokenSecret);</div>
|
|
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md10"></a>
|
|
2. Load Key from JSON file</h3>
|
|
<p>prepare file which written 'api-key' with json format. <br />
|
|
</p><div class="fragment"><div class="line">{</div>
|
|
<div class="line"> "consumer_key" : "your consumer key",</div>
|
|
<div class="line"> "consumer_secret" : "your consumer secret",</div>
|
|
<div class="line"> "access_token" : "your access token",</div>
|
|
<div class="line"> "access_token_secret" : "your access token secret"</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><p>then you can load api key from json file. <br />
|
|
</p><div class="fragment"><div class="line">#include "cocoatweet/oauth/key.h"</div>
|
|
<div class="line"> </div>
|
|
<div class="line">CocoaTweet::OAuth::Key key = CocoaTweet::OAuth::Key::fromJsonFile("api_key.json");</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md11"></a>
|
|
Generate API object</h2>
|
|
<p>generating API object with Key. <br />
|
|
this object is API entry point. <br />
|
|
</p>
|
|
<div class="fragment"><div class="line">#include "cocoatweet/api/api.h"</div>
|
|
<div class="line"> </div>
|
|
<div class="line">CocoaTweet::API::API api(key);</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md12"></a>
|
|
Use API</h2>
|
|
<div class="fragment"><div class="line">// Post a tweet</div>
|
|
<div class="line">api.status().Update("Hello, World!!\nTweet from Cocoa Twitter Library");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Upload a media</div>
|
|
<div class="line">auto media1 = api.media().Upload("path/to/file/image.jpeg");</div>
|
|
<div class="line">auto media2 = api.media().Upload("path/to/file/image2.png");</div>
|
|
<div class="line">api.status().Update("Upload media from Cocoa Twitter Library", std::vector<std::string>{media1.id(), media2.id()});</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Retweet a tweet</div>
|
|
<div class="line">api.status().Retweet("tweet id");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// un RT a tweet</div>
|
|
<div class="line">api.status().Unretweet("tweet id")</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Delete a tweet</div>
|
|
<div class="line">api.status().Destroy("tweet id");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Fav. a tweet</div>
|
|
<div class="line">api.favorite().Create("tweet id");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// un Fav. a tweet</div>
|
|
<div class="line">api.favorite().Destroy("tweet id");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// get a timeline with screen name</div>
|
|
<div class="line">auto timeline = api.status().UserTimeline("milkcocoa0902");</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// send a direct message</div>
|
|
<div class="line">// you cau get recipient_id using https://idtwi.com/</div>
|
|
<div class="line">api.directMessage().messageCreate("<recipient_id>", "Sent message using Cocoa Twitter Library");</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md13"></a>
|
|
More Information</h1>
|
|
<p>See <a href="https://cocoatweet.milkcocoa.info">API Document</a></p>
|
|
<p>donate by BitCoin : bc1qhpm8tmq72scqpl2ccemcf0ktfjg4rsu73e99tz <br />
|
|
</p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
<!-- 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.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|