RubyGems - steam-condenser - Versions diffs - 1.3.8.1 → 1.3.9 - Mend

steam-condenser 1.3.8.1 → 1.3.9

Files changed (476) hide show

data/pkg/steam-condenser-1.3.8.1/doc/AppNews.html ADDED Viewed

@@ -0,0 +1,1489 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: AppNews
+    &mdash; Metior — API Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index (A)</a> &raquo;
+    <span class="title">AppNews</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: AppNews
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">AppNews</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/app_news.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>This class represents Steam news and can be used to load a list of
+current
+news about specific games</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'>
+<p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#app_id-instance_method" title="#app_id (instance method)">- (Fixnum) <strong>app_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the Steam Application ID of the game this news belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#author-instance_method" title="#author (instance method)">- (String) <strong>author</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the name of the author of this news.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#contents-instance_method" title="#contents (instance method)">- (String) <strong>contents</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the contents of this news.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#date-instance_method" title="#date (instance method)">- (Time) <strong>date</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the date this news item has been published.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#feed_label-instance_method" title="#feed_label (instance method)">- (String) <strong>feed_label</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the name of the feed this news item belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#feed_name-instance_method" title="#feed_name (instance method)">- (String) <strong>feed_name</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the symbolic name of the feed this news item belongs to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#gid-instance_method" title="#gid (instance method)">- (Fixnum) <strong>gid</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a unique identifier for this news.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#title-instance_method" title="#title (instance method)">- (String) <strong>title</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the title of this news.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#url-instance_method" title="#url (instance method)">- (String) <strong>url</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the URL of the original news.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#news_for_app-class_method" title="news_for_app (class method)">+ (Array&lt;AppNews&gt;) <strong>news_for_app</strong>(app_id, count = 5, max_length = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Loads the news for the given game with the given restrictions.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#external%3F-instance_method" title="#external? (instance method)">- (Boolean) <strong>external?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns whether this news item originates from a source other than Steam
+itself (e.g. an external blog).</p>
+</div></span>
+</li>
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (AppNews) <strong>initialize</strong>(app_id, news_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new instance of an AppNews news item with the given data.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a simple textual representation of this news item.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="AppNews (class)">AppNews</a></span></tt>) <strong>initialize</strong>(app_id, news_data)  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a new instance of an AppNews news item with the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>app_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The unique Steam Application ID of the game (e.g.
+<code>440</code> for Team
+Fortress 2). See
+<a
+href="http://developer.valvesoftware.com/wiki/Steam_Application_IDs">developer.valvesoftware.com/wiki/Steam_Application_IDs</a>
+for
+all application IDs.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>news_data</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The news data extracted from JSON</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 120</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='rparen'>)</span>
+  <span class='ivar'>@app_id</span>      <span class='op'>=</span> <span class='id identifier rubyid_app_id'>app_id</span>
+  <span class='ivar'>@author</span>      <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:author</span><span class='rbracket'>]</span>
+  <span class='ivar'>@contents</span>    <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:contents</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
+  <span class='ivar'>@data</span>        <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:date</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='ivar'>@external</span>    <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:is_external_url</span><span class='rbracket'>]</span>
+  <span class='ivar'>@feed_label</span>  <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:feedlabel</span><span class='rbracket'>]</span>
+  <span class='ivar'>@feed_name</span>   <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:feedname</span><span class='rbracket'>]</span>
+  <span class='ivar'>@gid</span>         <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:gid</span><span class='rbracket'>]</span>
+  <span class='ivar'>@title</span>       <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:title</span><span class='rbracket'>]</span>
+  <span class='ivar'>@url</span>         <span class='op'>=</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="app_id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>app_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the Steam Application ID of the game this news belongs to</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The application ID of the game this news belongs to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 19</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_app_id'>app_id</span>
+  <span class='ivar'>@app_id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="author-instance_method">
+    - (<tt>String</tt>) <strong>author</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the name of the author of this news</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The author of this news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 24</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_author'>author</span>
+  <span class='ivar'>@author</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="contents-instance_method">
+    - (<tt>String</tt>) <strong>contents</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'>
+<p>Depending on the setting for the maximum length of a news
+(see
+<span class='object_link'><a href="#news_for_app-class_method" title="AppNews.news_for_app (method)">news_for_app</a></span>), the contents might be truncated.</p>
+</div>
+  </div>
+<p>Returns the contents of this news</p>
+<p>This might contain HTML code.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The contents of this news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+33
+34
+35</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 33</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_contents'>contents</span>
+  <span class='ivar'>@contents</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="date-instance_method">
+    - (<tt>Time</tt>) <strong>date</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the date this news item has been published</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Time</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The date this news has been published</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 38</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_date'>date</span>
+  <span class='ivar'>@date</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="feed_label-instance_method">
+    - (<tt>String</tt>) <strong>feed_label</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the name of the feed this news item belongs to</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The name of the feed this news belongs to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 43</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_feed_label'>feed_label</span>
+  <span class='ivar'>@feed_label</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="feed_name-instance_method">
+    - (<tt>String</tt>) <strong>feed_name</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the symbolic name of the feed this news item belongs to</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The symbolic name of the feed this news belongs to</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 48</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_feed_name'>feed_name</span>
+  <span class='ivar'>@feed_name</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="gid-instance_method">
+    - (<tt>Fixnum</tt>) <strong>gid</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a unique identifier for this news</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>A unique identifier for this news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 53</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_gid'>gid</span>
+  <span class='ivar'>@gid</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="title-instance_method">
+    - (<tt>String</tt>) <strong>title</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the title of this news</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The title of this news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 58</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
+  <span class='ivar'>@title</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="url-instance_method">
+    - (<tt>String</tt>) <strong>url</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the URL of the original news</p>
+<p>This is a direct link to the news on the Steam website or a
+redirecting
+link to the external post.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The URL of the original news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 66</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
+  <span class='ivar'>@url</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="news_for_app-class_method">
+    + (<tt>Array&lt;<span class='object_link'><a href="" title="AppNews (class)">AppNews</a></span>&gt;</tt>) <strong>news_for_app</strong>(app_id, count = 5, max_length = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Loads the news for the given game with the given restrictions</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>app_id</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The unique Steam Application ID of the game (e.g.
+<code>440</code> for Team
+Fortress 2). See
+<a
+href="http://developer.valvesoftware.com/wiki/Steam_Application_IDs">developer.valvesoftware.com/wiki/Steam_Application_IDs</a>
+for
+all application IDs.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>count</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>5</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The maximum number of news to load. There&#39;s no
+reliable way to load all
+news. Use a really great number instead.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>max_length</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>The maximum content length of the news. If a
+maximum length is defined, the
+content of the news will only be at
+most <code>max_length</code> characters
+long plus an ellipsis.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="AppNews (class)">AppNews</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>An array of news items for the specified game with
+the given options</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 81</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_news_for_app'>news_for_app</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>5</span><span class='comma'>,</span> <span class='id identifier rubyid_max_length'>max_length</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:appid</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='symbol'>:count</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_count'>count</span><span class='comma'>,</span> <span class='symbol'>:maxlength</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_max_length'>max_length</span> <span class='rbrace'>}</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_json'>json</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ISteamNews</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GetNewsForApp</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_news_items'>news_items</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='const'>MultiJson</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:symbolize_keys</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:appnews</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:newsitems</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_news_data'>news_data</span><span class='op'>|</span>
+    <span class='id identifier rubyid_news_items'>news_items</span> <span class='op'>&lt;&lt;</span> <span class='const'>AppNews</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_news_data'>news_data</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_news_items'>news_items</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="external?-instance_method">
+    - (<tt>Boolean</tt>) <strong>external?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns whether this news item originates from a source other than
+Steam
+itself (e.g. an external blog)</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p><code>true</code> if this news item is from an external source</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+97
+98
+99</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 97</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_external?'>external?</span>
+  <span class='ivar'>@external</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="to_s-instance_method">
+    - (<tt>String</tt>) <strong>to_s</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a simple textual representation of this news item</p>
+<p>Will consist of the name of the feed this news belongs to and the title
+of
+the news.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>A simple text representing this news</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+107
+108
+109</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/app_news.rb', line 107</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embvar'>#</span><span class='ivar'>@feed_label</span><span class='tstring_content'>: </span><span class='embvar'>#</span><span class='ivar'>@title</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:19 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-2.0.0).
+</div>
+  </body>
+</html>