Google Git
Sign in
apache / streams / refs/heads/asf-site / . / streams-contrib / streams-provider-twitter / apidocs / org / apache / streams / twitter / api / WelcomeMessageRules.html
blob: cd84edb36cd1913d78b54de77dc5db7193de7548 [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:52:08 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WelcomeMessageRules (streams-provider-twitter 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="WelcomeMessageRules (streams-provider-twitter 0.5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/WelcomeMessageRules.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/twitter/api/WelcomeMessageNewRuleResponseWrapper.html" title="class in org.apache.streams.twitter.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListRequest.html" title="class in org.apache.streams.twitter.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/twitter/api/WelcomeMessageRules.html" target="_top">Frames</a></li>
<li><a href="WelcomeMessageRules.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.twitter.api</div>
<h2 title="Interface WelcomeMessageRules" class="title">Interface WelcomeMessageRules</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/twitter/api/Twitter.html" title="class in org.apache.streams.twitter.api">Twitter</a></dd>
</dl>
<hr>
<br>
<pre>@Remoteable(path="https://api.twitter.com/1.1/direct_messages/welcome_messages/rules")
public interface <span class="typeNameLabel">WelcomeMessageRules</span></pre>
<div class="block">Interface for /direct_messages/welcome_messages/rules methods.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://dev.twitter.com/rest/reference">https://dev.twitter.com/rest/reference</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRules.html#destroyWelcomeMessageRule-java.lang.Long-">destroyWelcomeMessageRule</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</code>
<div class="block">Deletes a Welcome Message Rule by the given id.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListResponse.html" title="class in org.apache.streams.twitter.api">WelcomeMessageRulesListResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRules.html#listWelcomeMessageRules-org.apache.streams.twitter.api.WelcomeMessageRulesListRequest-">listWelcomeMessageRules</a></span>(<a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListRequest.html" title="class in org.apache.streams.twitter.api">WelcomeMessageRulesListRequest</a>&nbsp;parameters)</code>
<div class="block">Returns a list of Welcome Message Rules.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo">WelcomeMessageRule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRules.html#newWelcomeMessageRule-org.apache.streams.twitter.api.WelcomeMessageNewRuleRequest-">newWelcomeMessageRule</a></span>(<a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageNewRuleRequest.html" title="class in org.apache.streams.twitter.api">WelcomeMessageNewRuleRequest</a>&nbsp;body)</code>
<div class="block">Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo">WelcomeMessageRule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRules.html#showWelcomeMessageRule-java.lang.Long-">showWelcomeMessageRule</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</code>
<div class="block">Returns a Welcome Message Rule by the given 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="listWelcomeMessageRules-org.apache.streams.twitter.api.WelcomeMessageRulesListRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listWelcomeMessageRules</h4>
<pre>@RemoteMethod(httpMethod="GET",
path="/list.json")
<a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListResponse.html" title="class in org.apache.streams.twitter.api">WelcomeMessageRulesListResponse</a>&nbsp;listWelcomeMessageRules(@QueryIfNE
<a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListRequest.html" title="class in org.apache.streams.twitter.api">WelcomeMessageRulesListRequest</a>&nbsp;parameters)</pre>
<div class="block">Returns a list of Welcome Message Rules.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListResponse.html" title="class in org.apache.streams.twitter.api"><code>WelcomeMessageRulesListResponse</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-message-rules">https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-message-rules</a></dd>
</dl>
</li>
</ul>
<a name="showWelcomeMessageRule-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showWelcomeMessageRule</h4>
<pre>@RemoteMethod(httpMethod="GET",
path="/show.json")
<a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo">WelcomeMessageRule</a>&nbsp;showWelcomeMessageRule(@Query(value="id")
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</pre>
<div class="block">Returns a Welcome Message Rule by the given id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo"><code>WelcomeMessageRule</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message-rule">https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message-rule</a></dd>
</dl>
</li>
</ul>
<a name="newWelcomeMessageRule-org.apache.streams.twitter.api.WelcomeMessageNewRuleRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newWelcomeMessageRule</h4>
<pre>@RemoteMethod(httpMethod="POST",
path="/new.json")
<a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo">WelcomeMessageRule</a>&nbsp;newWelcomeMessageRule(@Body
<a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageNewRuleRequest.html" title="class in org.apache.streams.twitter.api">WelcomeMessageNewRuleRequest</a>&nbsp;body)</pre>
<div class="block">Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation. Returns the created rule if successful.
Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically.
Additional rule configurations are forthcoming. For the initial beta release, the most recently created Rule will always take precedence, and the assigned Welcome Message will be displayed in the conversation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../org/apache/streams/twitter/pojo/WelcomeMessageRule.html" title="class in org.apache.streams.twitter.pojo"><code>WelcomeMessageRule</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message-rule">https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message-rule</a></dd>
</dl>
</li>
</ul>
<a name="destroyWelcomeMessageRule-java.lang.Long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroyWelcomeMessageRule</h4>
<pre>@RemoteMethod(httpMethod="DELETE",
path="/destroy.json")
void&nbsp;destroyWelcomeMessageRule(@Query(value="id")
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</pre>
<div class="block">Deletes a Welcome Message Rule by the given id.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message-rule">https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message-rule</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/WelcomeMessageRules.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/twitter/api/WelcomeMessageNewRuleResponseWrapper.html" title="class in org.apache.streams.twitter.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/twitter/api/WelcomeMessageRulesListRequest.html" title="class in org.apache.streams.twitter.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/twitter/api/WelcomeMessageRules.html" target="_top">Frames</a></li>
<li><a href="WelcomeMessageRules.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>