camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Anstey (Confluence)" <conflue...@apache.org>
Subject [CONF] Apache Camel > Yammer
Date Wed, 10 Jul 2013 19:39:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/en/2176/1/1/_/styles/combined.css?spaceKey=CAMEL&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/CAMEL/Yammer">Yammer</a></h2>
    <h4>Page  <b>added</b> by             <a href="https://cwiki.apache.org/confluence/display/~janstey">Jonathan
Anstey</a>
    </h4>
         <br/>
    <div class="notificationGreySide">
         <h2><a name="Yammer-Yammer"></a>Yammer</h2>
<p><b>Available as of Camel 2.12</b></p>

<p>The Yammer component allows you to interact with the <a href="https://www.yammer.com"
class="external-link" rel="nofollow">Yammer</a> enterprise social network. Consuming
messages, users, and user relationships is supported as well as creating new messages.</p>

<p>Yammer uses OAuth 2 for all client application authentication.  In order to use camel-yammer
with your account, you'll need to create a new application within Yammer and grant the application
access to your account. Finally, generate your access token. More details are at <a href="https://developer.yammer.com/authentication/"
class="external-link" rel="nofollow">https://developer.yammer.com/authentication/</a></p>

<p>Maven users will need to add the following dependency to their pom.xml for this component:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Default; brush: xml; gutter: false" style="font-size:12px; font-family:
ConfluenceInstalledFont,monospace;">
&lt;dependency&gt;
    &lt;groupId&gt;org.apache.camel&lt;/groupId&gt;
    &lt;artifactId&gt;camel-yammer&lt;/artifactId&gt;
    &lt;version&gt;${camel-version}&lt;/version&gt;
&lt;/dependency&gt;
</pre>
</div></div>

<p><b>TODO: other message consumers, message producer, user/relationship stuff</b></p>

<h3><a name="Yammer-URIformat"></a>URI format</h3>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Default; brush: java; gutter: false" style="font-size:12px; font-family:
ConfluenceInstalledFont,monospace;">
yammer://[function]?[options]
</pre>
</div></div>

<h3><a name="Yammer-YammerComponent"></a>YammerComponent</h3>

<p>The yammer component can be configured with the Yammer account settings which are
mandatory to configure before using. You can also configure these options directly in the
endpoint.</p>
<div class="confluenceTableSmall"><div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Option </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> consumerKey </td>
<td class='confluenceTd'> The consumer key </td>
</tr>
<tr>
<td class='confluenceTd'> consumerSecret </td>
<td class='confluenceTd'> The consumer secret </td>
</tr>
<tr>
<td class='confluenceTd'> accessToken </td>
<td class='confluenceTd'> The access token </td>
</tr>
</tbody></table>
</div>

</div>

<h3><a name="Yammer-MessageConsumer"></a>Message Consumer</h3>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Default; brush: java; gutter: false" style="font-size:12px; font-family:
ConfluenceInstalledFont,monospace;">
yammer://messages?[options]
</pre>
</div></div>

<h4><a name="Yammer-URIOptions"></a>URI Options</h4>
<div class="confluenceTableSmall"><div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Name </th>
<th class='confluenceTh'> Default Value </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> delay </td>
<td class='confluenceTd'> <tt>5000</tt> </td>
<td class='confluenceTd'> in milliseconds </td>
</tr>
<tr>
<td class='confluenceTd'> consumerKey </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Consumer Key. Can also be configured on the <tt>YammerComponent</tt>
level instead. </td>
</tr>
<tr>
<td class='confluenceTd'> consumerSecret </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Consumer Secret. Can also be configured on the <tt>YammerComponent</tt>
level instead. </td>
</tr>
<tr>
<td class='confluenceTd'> accessToken </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Access Token. Can also be configured on the <tt>YammerComponent</tt>
level instead. </td>
</tr>
<tr>
<td class='confluenceTd'> limit </td>
<td class='confluenceTd'> <tt>-1</tt> </td>
<td class='confluenceTd'> Return only the specified number of messages. Works for threaded=true
and threaded=extended. </td>
</tr>
<tr>
<td class='confluenceTd'> threaded </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> threaded=true will only return the first message in each thread.
This parameter is intended for apps which display message threads collapsed. threaded=extended
will return the thread starter messages in order of most recently active as well as the two
most recent messages, as they are viewed in the default view on the Yammer web interface.
</td>
</tr>
<tr>
<td class='confluenceTd'> olderThan </td>
<td class='confluenceTd'> <tt>-1</tt> </td>
<td class='confluenceTd'> Returns messages older than the message ID specified as a
numeric string. This is useful for paginating messages. For example, if you’re currently
viewing 20 messages and the oldest is number 2912, you could append “?olderThan=2912″
to your request to get the 20 messages prior to those you’re seeing. </td>
</tr>
<tr>
<td class='confluenceTd'> newerThan</td>
<td class='confluenceTd'> <tt>-1</tt> </td>
<td class='confluenceTd'> Returns messages newer than the message ID specified as a
numeric string. This should be used when polling for new messages. If you’re looking at
messages, and the most recent message returned is 3516, you can make a request with the parameter
“?newerThan=3516″ to ensure that you do not get duplicate copies of messages already on
your page. </td>
</tr>
</tbody></table>
</div>
</div>

<h3><a name="Yammer-SeeAlso"></a>See Also</h3>
<ul>
	<li><a href="/confluence/display/CAMEL/Configuring+Camel" title="Configuring Camel">Configuring
Camel</a></li>
	<li><a href="/confluence/display/CAMEL/Component" title="Component">Component</a></li>
	<li><a href="/confluence/display/CAMEL/Endpoint" title="Endpoint">Endpoint</a></li>
	<li><a href="/confluence/display/CAMEL/Getting+Started" title="Getting Started">Getting
Started</a></li>
</ul>

    </div>
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;" class="grey">
                        <a href="https://cwiki.apache.org/confluence/users/removespacenotification.action?spaceKey=CAMEL">Stop
watching space</a>
            <span style="padding: 0px 5px;">|</span>
                <a href="https://cwiki.apache.org/confluence/users/editmyemailsettings.action">Change
email notification preferences</a>
</div>
       <a href="https://cwiki.apache.org/confluence/display/CAMEL/Yammer">View Online</a>
              |
       <a href="https://cwiki.apache.org/confluence/display/CAMEL/Yammer?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
           </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message