jeremytregunna/ruby-trello

View on GitHub
doc/Trello/ItemState.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>class Trello::ItemState - RDoc Documentation</title>

<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
</script>

<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>


<body id="top" class="class">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="../index.html">Home</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/trello/item_state.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    <nav id="parent-class-section" class="section">
  <h3 class="section-header">Parent</h3>
  
  <p class="link"><a href="BasicData.html">Trello::BasicData</a>
  
</nav>

    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-i-item">#item</a>
    
    <li><a href="#method-i-update_fields">#update_fields</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="../Gemfile.html">Gemfile</a>
  
    <li class="file"><a href="../LICENSE.html">LICENSE</a>
  
    <li class="file"><a href="../Rakefile.html">Rakefile</a>
  
    <li class="file"><a href="../test-credentials.html">test-credentials</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="../Trello.html">Trello</a>
  
    <li><a href="../Trello/Action.html">Trello::Action</a>
  
    <li><a href="../Trello/Association.html">Trello::Association</a>
  
    <li><a href="../Trello/AssociationProxy.html">Trello::AssociationProxy</a>
  
    <li><a href="../Trello/Authorization.html">Trello::Authorization</a>
  
    <li><a href="../Trello/Authorization/BasicAuthPolicy.html">Trello::Authorization::BasicAuthPolicy</a>
  
    <li><a href="../Trello/Authorization/Clock.html">Trello::Authorization::Clock</a>
  
    <li><a href="../Trello/Authorization/Nonce.html">Trello::Authorization::Nonce</a>
  
    <li><a href="../Trello/Authorization/OAuthPolicy.html">Trello::Authorization::OAuthPolicy</a>
  
    <li><a href="../Trello/BasicData.html">Trello::BasicData</a>
  
    <li><a href="../Trello/Board.html">Trello::Board</a>
  
    <li><a href="../Trello/Card.html">Trello::Card</a>
  
    <li><a href="../Trello/Checklist.html">Trello::Checklist</a>
  
    <li><a href="../Trello/Client.html">Trello::Client</a>
  
    <li><a href="../Trello/Error.html">Trello::Error</a>
  
    <li><a href="../Trello/HasActions.html">Trello::HasActions</a>
  
    <li><a href="../Trello/InvalidAccessToken.html">Trello::InvalidAccessToken</a>
  
    <li><a href="../Trello/Item.html">Trello::Item</a>
  
    <li><a href="../Trello/ItemState.html">Trello::ItemState</a>
  
    <li><a href="../Trello/Label.html">Trello::Label</a>
  
    <li><a href="../Trello/List.html">Trello::List</a>
  
    <li><a href="../Trello/Member.html">Trello::Member</a>
  
    <li><a href="../Trello/MultiAssociation.html">Trello::MultiAssociation</a>
  
    <li><a href="../Trello/Notification.html">Trello::Notification</a>
  
    <li><a href="../Trello/Organization.html">Trello::Organization</a>
  
    <li><a href="../Trello/TInternet.html">Trello::TInternet</a>
  
    <li><a href="../Trello/Token.html">Trello::Token</a>
  
    <li><a href="../IntegrationTest.html">IntegrationTest</a>
  
    <li><a href="../IntegrationTest/Container.html">IntegrationTest::Container</a>
  
    <li><a href="../Helpers.html">Helpers</a>
  
    <li><a href="../Object.html">Object</a>
  
    <li><a href="../String.html">String</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="class">class Trello::ItemState</h1>

  <div id="description" class="description">
    
<p>Represents the state of an item.</p>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    <!-- Methods -->
    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Instance Methods</h3>

    
      <div id="method-i-item" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">item</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Return the item this state belongs to.</p>
          

          
          <div class="method-source-code" id="item-source">
            <pre><span class="ruby-comment"># File lib/trello/item_state.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">item</span>
  <span class="ruby-constant">Item</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">item_id</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- item-source -->
          
        </div>

        

        
      </div><!-- item-method -->

    
      <div id="method-i-update_fields" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">update_fields</span><span
            class="method-args">(fields)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Update the fields of an item state.</p>

<p>Supply a hash of string keyed data retrieved from the <a
href="../Trello.html">Trello</a> API representing an item state.</p>
          

          
          <div class="method-source-code" id="update_fields-source">
            <pre><span class="ruby-comment"># File lib/trello/item_state.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_fields</span>(<span class="ruby-identifier">fields</span>)
  <span class="ruby-identifier">attributes</span>[<span class="ruby-value">:id</span>]      = <span class="ruby-identifier">fields</span>[<span class="ruby-string">'id'</span>]
  <span class="ruby-identifier">attributes</span>[<span class="ruby-value">:state</span>]   = <span class="ruby-identifier">fields</span>[<span class="ruby-string">'state'</span>]
  <span class="ruby-identifier">attributes</span>[<span class="ruby-value">:item_id</span>] = <span class="ruby-identifier">fields</span>[<span class="ruby-string">'idItem'</span>]
  <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- update_fields-source -->
          
        </div>

        

        
      </div><!-- update_fields-method -->

    
    </section><!-- public-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>