milkcocoa0902/CocoaTweet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
1c970995dec0c89b73776a5482f5f88436184d64
CocoaTweet/help/html/classCocoaTweet_1_1API_1_1Medias_1_1Upload.html
T

245 lines
18 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::Medias::Upload 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="namespaceCocoaTweet_1_1API_1_1Medias.html">Medias</a></li><li class="navelem"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html">Upload</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_1Medias_1_1Upload-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CocoaTweet::API::Medias::Upload Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>entry point for using media/upload endpoint
<a href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="upload_8h_source.html">upload.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CocoaTweet::API::Medias::Upload:</div>
<div class="dyncontent">
<div class="center"><img src="classCocoaTweet_1_1API_1_1Medias_1_1Upload__inherit__graph.png" border="0" usemap="#CocoaTweet_1_1API_1_1Medias_1_1Upload_inherit__map" alt="Inheritance graph"/></div>
<map name="CocoaTweet_1_1API_1_1Medias_1_1Upload_inherit__map" id="CocoaTweet_1_1API_1_1Medias_1_1Upload_inherit__map">
<area shape="rect" title="entry point for using media/upload endpoint" alt="" coords="11,184,195,225"/>
<area shape="rect" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpPost.html" title="class for Send request with POST method" alt="" coords="5,95,200,136"/>
<area shape="rect" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html" title=" " alt="" coords="5,5,200,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CocoaTweet::API::Medias::Upload:</div>
<div class="dyncontent">
<div class="center"><img src="classCocoaTweet_1_1API_1_1Medias_1_1Upload__coll__graph.png" border="0" usemap="#CocoaTweet_1_1API_1_1Medias_1_1Upload_coll__map" alt="Collaboration graph"/></div>
<map name="CocoaTweet_1_1API_1_1Medias_1_1Upload_coll__map" id="CocoaTweet_1_1API_1_1Medias_1_1Upload_coll__map">
<area shape="rect" title="entry point for using media/upload endpoint" alt="" coords="11,184,195,225"/>
<area shape="rect" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpPost.html" title="class for Send request with POST method" alt="" coords="5,95,200,136"/>
<area shape="rect" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html" title=" " alt="" coords="5,5,200,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a8b641cae9515e32b9d919c96dd7ee9bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#a8b641cae9515e32b9d919c96dd7ee9bb">Upload</a> ()</td></tr>
<tr class="memdesc:a8b641cae9515e32b9d919c96dd7ee9bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor <a href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#a8b641cae9515e32b9d919c96dd7ee9bb">More...</a><br /></td></tr>
<tr class="separator:a8b641cae9515e32b9d919c96dd7ee9bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1f706f8b1b71bec16a89eed8477c396"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#ac1f706f8b1b71bec16a89eed8477c396">media</a> (const std::string &amp;_media)</td></tr>
<tr class="memdesc:ac1f706f8b1b71bec16a89eed8477c396"><td class="mdescLeft">&#160;</td><td class="mdescRight">set media file with absolute path <a href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#ac1f706f8b1b71bec16a89eed8477c396">More...</a><br /></td></tr>
<tr class="separator:ac1f706f8b1b71bec16a89eed8477c396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80b625aa820e75f220823d78a26b04c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#a80b625aa820e75f220823d78a26b04c4">mediaId</a> (const std::string &amp;_mediaId)</td></tr>
<tr class="memdesc:a80b625aa820e75f220823d78a26b04c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">set media id(no affect to process. will be obsoleted) <a href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#a80b625aa820e75f220823d78a26b04c4">More...</a><br /></td></tr>
<tr class="separator:a80b625aa820e75f220823d78a26b04c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad47c77a4086bdf4f74b1aaecc86bce14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCocoaTweet_1_1API_1_1Model_1_1MediaStore.html">CocoaTweet::API::Model::MediaStore</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#ad47c77a4086bdf4f74b1aaecc86bce14">process</a> (std::weak_ptr&lt; <a class="el" href="classCocoaTweet_1_1OAuth_1_1OAuth1.html">CocoaTweet::OAuth::OAuth1</a> &gt; _oauth)</td></tr>
<tr class="memdesc:ad47c77a4086bdf4f74b1aaecc86bce14"><td class="mdescLeft">&#160;</td><td class="mdescRight">upload media <a href="classCocoaTweet_1_1API_1_1Medias_1_1Upload.html#ad47c77a4086bdf4f74b1aaecc86bce14">More...</a><br /></td></tr>
<tr class="separator:ad47c77a4086bdf4f74b1aaecc86bce14"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpPost"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpPost')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpPost.html">CocoaTweet::API::Interface::HttpPost</a></td></tr>
<tr class="memitem:afc4040a8d1b0853585334751717d0662 inherit pro_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpPost"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpPost.html#afc4040a8d1b0853585334751717d0662">process</a> (std::weak_ptr&lt; <a class="el" href="classCocoaTweet_1_1OAuth_1_1OAuth1.html">CocoaTweet::OAuth::OAuth1</a> &gt; _oauth, std::function&lt; void(const std::string &amp;)&gt; _callback)</td></tr>
<tr class="memdesc:afc4040a8d1b0853585334751717d0662 inherit pro_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpPost"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send HTTP/POST using <a class="el" href="namespaceCocoaTweet_1_1OAuth.html">OAuth</a> object. <a href="classCocoaTweet_1_1API_1_1Interface_1_1HttpPost.html#afc4040a8d1b0853585334751717d0662">More...</a><br /></td></tr>
<tr class="separator:afc4040a8d1b0853585334751717d0662 inherit pro_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpPost"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase')"><img src="closed.png" alt="-"/>&#160;Static Protected Member Functions inherited from <a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html">CocoaTweet::API::Interface::HttpBase</a></td></tr>
<tr class="memitem:a65e649cd380fc68d69aa8b575a20ab10 inherit pro_static_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html#a65e649cd380fc68d69aa8b575a20ab10">curlCallback_</a> (char *_ptr, size_t _size, size_t _nmemb, std::string *_stream)</td></tr>
<tr class="separator:a65e649cd380fc68d69aa8b575a20ab10 inherit pro_static_methods_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html">CocoaTweet::API::Interface::HttpBase</a></td></tr>
<tr class="memitem:ab0b8b76e12fdf34849fc1c8ee928a2ff inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memItemLeft" align="right" valign="top">std::weak_ptr&lt; <a class="el" href="classCocoaTweet_1_1OAuth_1_1OAuth1.html">CocoaTweet::OAuth::OAuth1</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html#ab0b8b76e12fdf34849fc1c8ee928a2ff">oauth_</a></td></tr>
<tr class="separator:ab0b8b76e12fdf34849fc1c8ee928a2ff inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c543dfa69524004df9e0fdcaa610313 inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html#a7c543dfa69524004df9e0fdcaa610313">bodyParam_</a></td></tr>
<tr class="separator:a7c543dfa69524004df9e0fdcaa610313 inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6511d018265ca90a5c675b375b8feee0 inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html#a6511d018265ca90a5c675b375b8feee0">url_</a></td></tr>
<tr class="separator:a6511d018265ca90a5c675b375b8feee0 inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa80a8d2b339e3eed6f9e031518f8193b inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCocoaTweet_1_1API_1_1Interface_1_1HttpBase.html#aa80a8d2b339e3eed6f9e031518f8193b">contentType_</a></td></tr>
<tr class="separator:aa80a8d2b339e3eed6f9e031518f8193b inherit pro_attribs_classCocoaTweet_1_1API_1_1Interface_1_1HttpBase"><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>entry point for using media/upload endpoint </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b641cae9515e32b9d919c96dd7ee9bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b641cae9515e32b9d919c96dd7ee9bb">&#9670;&nbsp;</a></span>Upload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CocoaTweet::API::Medias::Upload::Upload </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>default constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac1f706f8b1b71bec16a89eed8477c396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1f706f8b1b71bec16a89eed8477c396">&#9670;&nbsp;</a></span>media()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CocoaTweet::API::Medias::Upload::media </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_media</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set media file with absolute path </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">const</td><td>std::string&amp; _media : absolute path to media should be uploaded </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">none</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a80b625aa820e75f220823d78a26b04c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80b625aa820e75f220823d78a26b04c4">&#9670;&nbsp;</a></span>mediaId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CocoaTweet::API::Medias::Upload::mediaId </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_mediaId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set media id(no affect to process. will be obsoleted) </p>
</div>
</div>
<a id="ad47c77a4086bdf4f74b1aaecc86bce14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad47c77a4086bdf4f74b1aaecc86bce14">&#9670;&nbsp;</a></span>process()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCocoaTweet_1_1API_1_1Model_1_1MediaStore.html">CocoaTweet::API::Model::MediaStore</a> CocoaTweet::API::Medias::Upload::process </td>
<td>(</td>
<td class="paramtype">std::weak_ptr&lt; <a class="el" href="classCocoaTweet_1_1OAuth_1_1OAuth1.html">CocoaTweet::OAuth::OAuth1</a> &gt;&#160;</td>
<td class="paramname"><em>_oauth</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>upload media </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">std::weak_ptr&lt;CocoaTweet::OAuth::OAuth1&gt;</td><td>_oauth : pointer to <a class="el" href="namespaceCocoaTweet_1_1OAuth.html">OAuth</a> object for authenticate </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname"><a class="el" href="classCocoaTweet_1_1API_1_1Model_1_1MediaStore.html" title="data class for tweet object">CocoaTweet::API::Model::MediaStore</a></td><td>: media upload result. use id() for post tweet. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/cocoatweet/api/media/<a class="el" href="upload_8h_source.html">upload.h</a></li>
<li>src/cocoatweet/api/media/<a class="el" href="upload_8cc.html">upload.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