Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2025-01-30 11:59:02 +08:00
Code Issues Projects Releases Packages Wiki Activity

add edit urls links for models

Browse source
This commit is contained in:
dillon 2015-10-03 12:05:22 -07:00
parent 2d0dbed0c3
commit 3e7362c7ef
9 changed files with 65 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/Account.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Account
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/account.coffee"
---
<h2>Summary</h2>
@ -35,22 +36,22 @@ labels.</p>
<h4 id=usesLabels class="function-name">
usesLabels(<span class="args"></span>) <a href="#usesLabels" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>The current organization_unit used by the account. </p>
</p>
</div>
<h4 id=displayProvider class="function-name">
displayProvider(<span class="args"></span>) <a href="#displayProvider" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -60,4 +61,3 @@ labels.</p>
like Gmail, Exchange, or Outlook 365</p>
</td></tr>
</table>

6
docs/Calendar.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Calendar
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/calendar.coffee"
---
<h2>Summary</h2>
@ -18,8 +19,3 @@ For more information about Calendar on the Nylas Platform, read the
<ul>
</ul>

14
docs/Contact.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Contact
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/contact.coffee"
---
<h2>Summary</h2>
@ -34,12 +35,12 @@ grow as the needs of a contact become more complex.</p>
<h4 id=toString class="function-name">
toString(<span class="args"></span>) <a href="#toString" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -52,12 +53,12 @@ grow as the needs of a contact become more complex.</p>
<h4 id=isMe class="function-name">
isMe(<span class="args"></span>) <a href="#isMe" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -68,4 +69,3 @@ grow as the needs of a contact become more complex.</p>
the account email, since it is case-insensitive and future-proof.</p>
</td></tr>
</table>

14
docs/File.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: File
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/file.coffee"
---
<h2>Summary</h2>
@ -31,24 +32,24 @@ is a string that matches a cid:<value> found in the HTML body of a <a href='mess
<h4 id=displayName class="function-name">
displayName(<span class="args"></span>) <a href="#displayName" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Files can have empty names, or no name. <code>displayName</code> returns the file&#39;s
name if one is present, and falls back to appropriate default name based on
the contentType. It will always return a non-empty string.</p>
</p>
</div>
<h4 id=displayExtension class="function-name">
displayExtension(<span class="args"></span>) <a href="#displayExtension" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -62,4 +63,3 @@ is a string that matches a cid:<value> found in the HTML body of a <a href='mess
<tr><td class="markdown-from-sourecode"><p>Returns the extension without the leading &#39;.&#39; (ex: &#39;png&#39;, &#39;pdf&#39;)</p>
</td></tr>
</table>

6
docs/Folder.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Folder
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/folder.coffee"
---
<h2>Summary</h2>
@ -39,8 +40,3 @@ boolean values on messages and threads.</p>
<ul>
</ul>

6
docs/Label.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Label
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/label.coffee"
---
<h2>Summary</h2>
@ -39,8 +40,3 @@ boolean values on messages and threads.</p>
<ul>
</ul>

44
docs/Message.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Message
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/message.coffee"
---
<h2>Summary</h2>
@ -53,12 +54,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=participants class="function-name">
participants(<span class="args"></span>) <a href="#participants" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -71,12 +72,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=participantsForReplyAll class="function-name">
participantsForReplyAll(<span class="args"></span>) <a href="#participantsForReplyAll" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -90,12 +91,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=participantsForReply class="function-name">
participantsForReply(<span class="args"></span>) <a href="#participantsForReply" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -109,12 +110,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=fileIds class="function-name">
fileIds(<span class="args"></span>) <a href="#fileIds" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -126,12 +127,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=isFromMe class="function-name">
isFromMe(<span class="args"></span>) <a href="#isFromMe" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -145,12 +146,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=plainTextBody class="function-name">
plainTextBody(<span class="args"></span>) <a href="#plainTextBody" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -163,12 +164,12 @@ All messages are part of a thread, even if that thread has only one message.</p>
<h4 id=replyAttributionLine class="function-name">
replyAttributionLine(<span class="args"></span>) <a href="#replyAttributionLine" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -179,4 +180,3 @@ All messages are part of a thread, even if that thread has only one message.</p>
ie &quot;On Dec. 12th, 2015 at 4:00PM, Ben Gotow wrote:&quot;</p>
</td></tr>
</table>

26
docs/Model.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Model
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/model.coffee"
---
<h2>Summary</h2>
@ -38,12 +39,12 @@ object.</p>
<h4 id=attributes class="function-name">
attributes(<span class="args"></span>) <a href="#attributes" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -55,13 +56,13 @@ object.</p>
<h4 id=toJSON class="function-name">
toJSON(<span class="args"><span class="arg">[options]</span></span>) <a href="#toJSON" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Deflates the model to a plain JSON object. Only attributes defined
on the model are included in the JSON.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -75,11 +76,11 @@ object.</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with additional options. To skip joined data attributes in the toJSON representation, pass the <code>joined:false</code></p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -91,12 +92,12 @@ object.</p>
<h4 id=matches class="function-name">
matches(<span class="args"><span class="arg">criteria</span></span>) <a href="#matches" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Evaluates the model against one or more <a href='matcher.html'>Matcher</a> objects.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -108,13 +109,13 @@ object.</p>
<em>criteria</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='matcher.html'>Matcher</a>s to run on the model.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -123,4 +124,3 @@ object.</p>
<tr><td class="markdown-from-sourecode"><p>Returns true if the model matches the criteria.</p>
</td></tr>
</table>

12
docs/Thread.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Thread
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/thread.coffee"
---
<h2>Summary</h2>
@ -37,11 +38,11 @@ For more information about Threads on the Nylas Platform, read the
<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>
@ -53,13 +54,13 @@ For more information about Threads on the Nylas Platform, read the
<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>
@ -70,4 +71,3 @@ For more information about Threads on the Nylas Platform, read the
<code>names</code></p>
</td></tr>
</table>