Google Git
Sign in
apache / streams / refs/heads/asf-site / . / streams-contrib / streams-provider-instagram / apidocs / org / apache / streams / instagram / api / Media.html
blob: 89251adcc40f9bb8618bbb0a3a80d4f4cebb6eee [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_152) on Mon Apr 02 22:51:30 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Media (streams-provider-instagram 0.5.2-SNAPSHOT API)</title>
<meta name="date" content="2018-04-02">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Media (streams-provider-instagram 0.5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Media.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/streams/instagram/api/InstagramRetryHandler.html" title="class in org.apache.streams.instagram.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/instagram/api/Media.html" target="_top">Frames</a></li>
<li><a href="Media.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.streams.instagram.api</div>
<h2 title="Interface Media" class="title">Interface Media</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/streams/instagram/api/Instagram.html" title="class in org.apache.streams.instagram.api">Instagram</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Media</span></pre>
<div class="block">Media Endpoints.
Comments Endpoints.
Like Endpoints.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/media/">https://www.instagram.com/developer/endpoints/media/</a>,
<a href="https://www.instagram.com/developer/endpoints/comments/">https://www.instagram.com/developer/endpoints/comments/</a>,
<a href="https://www.instagram.com/developer/endpoints/likes/">https://www.instagram.com/developer/endpoints/likes/</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/instagram/api/CommentsResponse.html" title="class in org.apache.streams.instagram.api">CommentsResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/instagram/api/Media.html#comments-java.lang.String-">comments</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</code>
<div class="block">Get a list of recent comments on a media object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/instagram/api/UsersInfoResponse.html" title="class in org.apache.streams.instagram.api">UsersInfoResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/instagram/api/Media.html#likes-java.lang.String-">likes</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</code>
<div class="block">Get a list of users who have liked this media.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api">MediaResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/instagram/api/Media.html#lookupMedia-java.lang.String-">lookupMedia</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</code>
<div class="block">Get information about a media object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/instagram/api/SearchMediaResponse.html" title="class in org.apache.streams.instagram.api">SearchMediaResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/instagram/api/Media.html#searchMedia-org.apache.streams.instagram.api.SearchMediaRequest-">searchMedia</a></span>(<a href="../../../../../org/apache/streams/instagram/api/SearchMediaRequest.html" title="class in org.apache.streams.instagram.api">SearchMediaRequest</a>&nbsp;parameters)</code>
<div class="block">Search for recent media in a given area.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api">MediaResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/instagram/api/Media.html#shortcode-java.lang.String-">shortcode</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;shortcode)</code>
<div class="block">This endpoint returns the same response as GET /media/media-id.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="comments-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comments</h4>
<pre><a href="../../../../../org/apache/streams/instagram/api/CommentsResponse.html" title="class in org.apache.streams.instagram.api">CommentsResponse</a>&nbsp;comments(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</pre>
<div class="block">Get a list of recent comments on a media object.
The public_content scope is required for media that does not belong to the owner of the access_token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>media_id</code> - media_id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CommentsResponse @link{CommentsResponse}</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/comments/#get_media_comments">https://www.instagram.com/developer/endpoints/comments/#get_media_comments</a></dd>
</dl>
</li>
</ul>
<a name="likes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>likes</h4>
<pre><a href="../../../../../org/apache/streams/instagram/api/UsersInfoResponse.html" title="class in org.apache.streams.instagram.api">UsersInfoResponse</a>&nbsp;likes(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</pre>
<div class="block">Get a list of users who have liked this media.
The public_content scope is required for media that does not belong to the owner of the access_token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>media_id</code> - media_id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UsersInfoResponse @link{UsersInfoResponse}</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/likes/#get_media_likes">https://www.instagram.com/developer/endpoints/likes/#get_media_likes</a></dd>
</dl>
</li>
</ul>
<a name="lookupMedia-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupMedia</h4>
<pre><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api">MediaResponse</a>&nbsp;lookupMedia(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;media_id)</pre>
<div class="block">Get information about a media object. Use the type field to differentiate between image and video media in the response. You will also receive the user_has_liked field which tells you whether the owner of the access_token has liked this media.
The public_content permission scope is required to get a media that does not belong to the owner of the access_token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>media_id</code> - media_id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MediaResponse @link{MediaResponse}</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/media/#get_media">https://www.instagram.com/developer/endpoints/media/#get_media</a></dd>
</dl>
</li>
</ul>
<a name="shortcode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shortcode</h4>
<pre><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api">MediaResponse</a>&nbsp;shortcode(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;shortcode)</pre>
<div class="block">This endpoint returns the same response as GET /media/media-id.
A media object's shortcode can be found in its shortlink URL. An example shortlink is http://instagram.com/p/tsxp1hhQTG/. Its corresponding shortcode is tsxp1hhQTG.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shortcode</code> - shortcode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MediaResponse @link{MediaResponse}</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/media/#get_media_by_shortcode">https://www.instagram.com/developer/endpoints/media/#get_media_by_shortcode</a></dd>
</dl>
</li>
</ul>
<a name="searchMedia-org.apache.streams.instagram.api.SearchMediaRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>searchMedia</h4>
<pre><a href="../../../../../org/apache/streams/instagram/api/SearchMediaResponse.html" title="class in org.apache.streams.instagram.api">SearchMediaResponse</a>&nbsp;searchMedia(<a href="../../../../../org/apache/streams/instagram/api/SearchMediaRequest.html" title="class in org.apache.streams.instagram.api">SearchMediaRequest</a>&nbsp;parameters)</pre>
<div class="block">Search for recent media in a given area.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - @link{SearchMediaRequest}</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SearchMediaResponse @link{SearchMediaResponse}</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.instagram.com/developer/endpoints/media/#get_media_search">https://www.instagram.com/developer/endpoints/media/#get_media_search</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Media.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/streams/instagram/api/InstagramRetryHandler.html" title="class in org.apache.streams.instagram.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/instagram/api/MediaResponse.html" title="class in org.apache.streams.instagram.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/instagram/api/Media.html" target="_top">Frames</a></li>
<li><a href="Media.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>