Mailspring/docs/Thread.html
2015-10-03 12:05:22 -07:00

73 lines
2.7 KiB
HTML

---
layout: docs
title: Thread
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/thread.coffee"
---
<h2>Summary</h2>
<div class="markdown-from-sourecode">
<p><p>The Thread model represents a Thread object served by the Nylas Platform API.
For more information about Threads on the Nylas Platform, read the
<a href="https://nylas.com/docs/api#threads">Threads API Documentation</a></p>
<h2 id="attributes">Attributes</h2>
<p><code>snippet</code>: <a href='attributestring.html'>AttributeString</a> A short, ~140 character string with the content
of the last message in the thread. Queryable.</p>
<p><code>subject</code>: <a href='attributestring.html'>AttributeString</a> The subject of the thread. Queryable.</p>
<p><code>unread</code>: <a href='attributeboolean.html'>AttributeBoolean</a> True if the thread is unread. Queryable.</p>
<p><code>starred</code>: <a href='attributeboolean.html'>AttributeBoolean</a> True if the thread is starred. Queryable.</p>
<p><code>version</code>: <a href='attributenumber.html'>AttributeNumber</a> The version number of the thread.</p>
<p><code>participants</code>: <a href='attributecollection.html'>AttributeCollection</a> A set of <a href='contact.html'>Contact</a> models
representing the participants in the thread.
Note: Contacts on Threads do not have IDs.</p>
<p><code>lastMessageReceivedTimestamp</code>: <a href='attributedatetime.html'>AttributeDateTime</a> The timestamp of the
last message on the thread.</p>
<p>This class also inherits attributes from <a href='model.html'>Model</a></p>
</p>
</div>
<ul>
</ul>
<h3>Instance Methods</h3>
<h4 id=categoryNamed class="function-name">
categoryNamed(<span class="args"><span class="arg">id</span></span>) <a href="#categoryNamed" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td style="width:15%;">
<em>id</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> {Category} name</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
<th>Return Values</th>
</tr>
<tr><td class="markdown-from-sourecode"><p>Returns true if the thread has a {Category} with the given
name. Note, only <code>CategoryStore::standardCategories</code> have valid
<code>names</code></p>
</td></tr>
</table>