<!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: ZendeskAPI::OrganizationField — Documentation by YARD 0.8.5.2 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" 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 (O)</a> » <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span> » <span class="title">OrganizationField</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: ZendeskAPI::OrganizationField </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName"><span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></li> <li class="next"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></li> <li class="next"><span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span></li> <li class="next">ZendeskAPI::OrganizationField</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/zendesk_api/resources.rb</dd> </dl> <div class="clear"></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="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a> </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span> </span> <span class="summary_desc"><div class='inline'> <p>The association.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a> (also: #to_param) </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'> <p>The resource's attributes.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a> </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute error.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a> </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute error_message.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a> </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span> </span> <span class="summary_desc"><div class='inline'> <p>The last received errors.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a> </span> <span class="note title not_defined_here"> inherited from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span> </span> <span class="summary_desc"><div class='inline'> <p>Place to dump the last response.</p> </div></span> </li> </ul> <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="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">ZendeskAPI::Data</a></span></p> </div> <div id="method_missing_details" class="method_details_list"> <h2>Dynamic Method Handling</h2> <p class="notice super"> This class handles dynamic methods through the <tt>method_missing</tt> method in the class <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">ZendeskAPI::Data</a></span> </p> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="association=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="association-instance_method"> - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>The association</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span> — <div class='inline'> <p>The association</p> </div> </li> </ul> </div> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="attributes-instance_method"> - (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span> <span class="aliases">Also known as: <span class="names"><span id='to_param-instance_method'>to_param</span></span> </span> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>The resource's attributes</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Hash</tt>)</span> — <div class='inline'> <p>The resource's attributes</p> </div> </li> </ul> </div> </div> <span id="error=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="error-instance_method"> - (<tt>Object</tt>) <strong>error</strong> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute error</p> </div> </div> <div class="tags"> </div> </div> <span id="error_message=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="error_message-instance_method"> - (<tt>Object</tt>) <strong>error_message</strong> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute error_message</p> </div> </div> <div class="tags"> </div> </div> <span id="errors=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="errors-instance_method"> - (<tt>Array</tt>) <strong>errors</strong> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>The last received errors</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <div class='inline'> <p>The last received errors</p> </div> </li> </ul> </div> </div> <span id="response=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="response-instance_method"> - (<tt>Object</tt>) <strong>response</strong> <span class="not_defined_here"> Originally defined in class <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Place to dump the last response</p> </div> </div> <div class="tags"> </div> </div> </div> </div> <div id="footer"> Generated on Wed May 15 18:59:36 2013 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.5.2 (ruby-1.9.3). </div> </body> </html>