<!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::TopicComment
— 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 (T)</a> »
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
»
<span class="title">TopicComment</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::TopicComment
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</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">ZendeskAPI::TopicComment</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>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">ZendeskAPI::Topic::TopicComment</a></span>, <span class='object_link'><a href="User/TopicComment.html" title="ZendeskAPI::User::TopicComment (class)">User::TopicComment</a></span></p>
</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="#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>
<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="#attachments-instance_method" title="#attachments (instance method)">- (ZendeskAPI::Attachment) <strong>attachments</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#attachments%3D-instance_method" title="#attachments= (instance method)">- (ZendeskAPI::Attachment) <strong>attachments=</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#topic-instance_method" title="#topic (instance method)">- (ZendeskAPI::Topic) <strong>topic</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#topic%3D-instance_method" title="#topic= (instance method)">- (ZendeskAPI::Topic) <strong>topic=</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user-instance_method" title="#user (instance method)">- (ZendeskAPI::User) <strong>user</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user%3D-instance_method" title="#user= (instance method)">- (ZendeskAPI::User) <strong>user=</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The associated object.</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="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 id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="attachments-instance_method">
- (<tt><span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">ZendeskAPI::Attachment</a></span></tt>) <strong>attachments</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>Options to pass to the collection object</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">ZendeskAPI::Attachment</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 101</span>
<span class='id identifier rubyid_has_many'>has_many</span> <span class='const'>Attachment</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="attachments=-instance_method">
- (<tt><span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">ZendeskAPI::Attachment</a></span></tt>) <strong>attachments=</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Hash or <span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">ZendeskAPI::Attachment</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object or its attributes</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">ZendeskAPI::Attachment</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 101</span>
<span class='id identifier rubyid_has_many'>has_many</span> <span class='const'>Attachment</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="topic-instance_method">
- (<tt><span class='object_link'><a href="Topic.html" title="ZendeskAPI::Topic (class)">ZendeskAPI::Topic</a></span></tt>) <strong>topic</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</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="Topic.html" title="ZendeskAPI::Topic (class)">ZendeskAPI::Topic</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 99</span>
<span class='id identifier rubyid_has'>has</span> <span class='const'>Topic</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="topic=-instance_method">
- (<tt><span class='object_link'><a href="Topic.html" title="ZendeskAPI::Topic (class)">ZendeskAPI::Topic</a></span></tt>) <strong>topic=</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Hash or <span class='object_link'><a href="Topic.html" title="ZendeskAPI::Topic (class)">ZendeskAPI::Topic</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object or its attributes</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Topic.html" title="ZendeskAPI::Topic (class)">ZendeskAPI::Topic</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 99</span>
<span class='id identifier rubyid_has'>has</span> <span class='const'>Topic</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user-instance_method">
- (<tt><span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>) <strong>user</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</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="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 100</span>
<span class='id identifier rubyid_has'>has</span> <span class='const'>User</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user=-instance_method">
- (<tt><span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>) <strong>user=</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>The associated object</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Hash or <span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object or its attributes</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>)</span>
—
<div class='inline'>
<p>The associated object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 100</span>
<span class='id identifier rubyid_has'>has</span> <span class='const'>User</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed May 15 18:59:32 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>