doc/Trello/CheckItemState.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Trello::CheckItemState
— Documentation by YARD 0.9.25
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Trello::CheckItemState";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../Trello.html" title="Trello (module)">Trello</a></span></span>
»
<span class="title">CheckItemState</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Trello::CheckItemState
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></li>
<li class="next">Trello::CheckItemState</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/trello/item_state.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents the state of an item.</p>
</div>
</div>
<div class="tags">
</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="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></h3>
<p class="inherited"><span class='object_link'><a href="BasicData.html#client-instance_method" title="Trello::BasicData#client (method)">#client</a></span></p>
<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="#item-instance_method" title="#item (instance method)">#<strong>item</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the item this state belongs to.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></h3>
<p class="inherited"><span class='object_link'><a href="BasicData.html#==-instance_method" title="Trello::BasicData#== (method)">#==</a></span>, <span class='object_link'><a href="BasicData.html#attributes-instance_method" title="Trello::BasicData#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="BasicData.html#client-class_method" title="Trello::BasicData.client (method)">client</a></span>, <span class='object_link'><a href="BasicData.html#collection_name-instance_method" title="Trello::BasicData#collection_name (method)">#collection_name</a></span>, <span class='object_link'><a href="BasicData.html#collection_path-instance_method" title="Trello::BasicData#collection_path (method)">#collection_path</a></span>, <span class='object_link'><a href="BasicData.html#create-class_method" title="Trello::BasicData.create (method)">create</a></span>, <span class='object_link'><a href="BasicData.html#element_name-instance_method" title="Trello::BasicData#element_name (method)">#element_name</a></span>, <span class='object_link'><a href="BasicData.html#element_path-instance_method" title="Trello::BasicData#element_path (method)">#element_path</a></span>, <span class='object_link'><a href="BasicData.html#find-class_method" title="Trello::BasicData.find (method)">find</a></span>, <span class='object_link'><a href="BasicData.html#hash-instance_method" title="Trello::BasicData#hash (method)">#hash</a></span>, <span class='object_link'><a href="BasicData.html#initialize-instance_method" title="Trello::BasicData#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="BasicData.html#many-class_method" title="Trello::BasicData.many (method)">many</a></span>, <span class='object_link'><a href="BasicData.html#one-class_method" title="Trello::BasicData.one (method)">one</a></span>, <span class='object_link'><a href="BasicData.html#parse-class_method" title="Trello::BasicData.parse (method)">parse</a></span>, <span class='object_link'><a href="BasicData.html#parse_many-class_method" title="Trello::BasicData.parse_many (method)">parse_many</a></span>, <span class='object_link'><a href="BasicData.html#path_name-class_method" title="Trello::BasicData.path_name (method)">path_name</a></span>, <span class='object_link'><a href="BasicData.html#refresh!-instance_method" title="Trello::BasicData#refresh! (method)">#refresh!</a></span>, <span class='object_link'><a href="BasicData.html#register_attrs-class_method" title="Trello::BasicData.register_attrs (method)">register_attrs</a></span>, <span class='object_link'><a href="BasicData.html#save-class_method" title="Trello::BasicData.save (method)">save</a></span>, <span class='object_link'><a href="BasicData.html#save-instance_method" title="Trello::BasicData#save (method)">#save</a></span>, <span class='object_link'><a href="BasicData.html#schema-class_method" title="Trello::BasicData.schema (method)">schema</a></span>, <span class='object_link'><a href="BasicData.html#schema-instance_method" title="Trello::BasicData#schema (method)">#schema</a></span>, <span class='object_link'><a href="BasicData.html#update!-instance_method" title="Trello::BasicData#update! (method)">#update!</a></span>, <span class='object_link'><a href="BasicData.html#update_fields-instance_method" title="Trello::BasicData#update_fields (method)">#update_fields</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="JsonUtils.html" title="Trello::JsonUtils (module)">JsonUtils</a></span></h3>
<p class="inherited"><span class='object_link'><a href="JsonUtils.html#included-class_method" title="Trello::JsonUtils.included (method)">included</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicData.html#initialize-instance_method" title="Trello::BasicData#initialize (method)">Trello::BasicData</a></span></p>
</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="id-instance_method">
#<strong>id</strong> ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello/item_state.rb', line 8</span>
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="Trello::CheckItemState (class)">CheckItemState</a></span></span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></span>
<span class='id identifier rubyid_schema'>schema</span> <span class='kw'>do</span>
<span class='comment'>#Readonly
</span> <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='label'>remote_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>idCheckItem</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>readonly:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>primary_key:</span> <span class='kw'>true</span>
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:state</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_validates_presence_of'>validates_presence_of</span> <span class='symbol'>:id</span>
<span class='comment'># Return the item this state belongs to.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span>
<span class='const'><span class='object_link'><a href="Item.html" title="Trello::Item (class)">Item</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="BasicData.html#find-class_method" title="Trello::BasicData.find (method)">find</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="state-instance_method">
#<strong>state</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello/item_state.rb', line 8</span>
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="Trello::CheckItemState (class)">CheckItemState</a></span></span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="BasicData.html" title="Trello::BasicData (class)">BasicData</a></span></span>
<span class='id identifier rubyid_schema'>schema</span> <span class='kw'>do</span>
<span class='comment'>#Readonly
</span> <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='label'>remote_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>idCheckItem</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>readonly:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>primary_key:</span> <span class='kw'>true</span>
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:state</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_validates_presence_of'>validates_presence_of</span> <span class='symbol'>:id</span>
<span class='comment'># Return the item this state belongs to.
</span> <span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span>
<span class='const'><span class='object_link'><a href="Item.html" title="Trello::Item (class)">Item</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="BasicData.html#find-class_method" title="Trello::BasicData.find (method)">find</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</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="item-instance_method">
#<strong>item</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the item this state belongs to.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello/item_state.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span>
<span class='const'><span class='object_link'><a href="Item.html" title="Trello::Item (class)">Item</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="BasicData.html#find-class_method" title="Trello::BasicData.find (method)">find</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Nov 10 16:31:56 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
</div>
</div>
</body>
</html>