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

add edit urls for stores

Browse source
This commit is contained in:
dillon 2015-10-03 12:39:12 -07:00
parent ca2e0826a1
commit 4ae83ba4e3
13 changed files with 214 additions and 232 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/AccountStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: AccountStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/account-store.coffee"
---
<h2>Summary</h2>
@ -23,12 +24,12 @@ the database and exposes the currently active Account via <a href='#current'>cur
<h4 id=items class="function-name">
items(<span class="args"></span>) <a href="#items" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -40,12 +41,12 @@ the database and exposes the currently active Account via <a href='#current'>cur
<h4 id=itemWithEmailAddress class="function-name">
itemWithEmailAddress(<span class="args"></span>) <a href="#itemWithEmailAddress" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -57,12 +58,12 @@ the database and exposes the currently active Account via <a href='#current'>cur
<h4 id=current class="function-name">
current(<span class="args"></span>) <a href="#current" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -71,4 +72,3 @@ the database and exposes the currently active Account via <a href='#current'>cur
<tr><td class="markdown-from-sourecode"><p>Returns the currently active <a href='account.html'>Account</a>.</p>
</td></tr>
</table>

20
docs/ContactStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ContactStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/contact-store.coffee"
---
<h2>Summary</h2>
@ -33,14 +34,14 @@ to refresh data based on the ContactStore.</p>
<h4 id=searchContacts class="function-name">
searchContacts(<span class="args"><span class="arg">search</span><span class="arg">[options]</span></span>) <a href="#searchContacts" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Search the user&#39;s contact list for the given search term.
This method compares the <code>search</code> string against each Contact&#39;s
<code>name</code> and <code>email</code>.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -52,9 +53,9 @@ to refresh data based on the ContactStore.</p>
<em>search</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> A search phrase, such as <code>ben@n</code> or <code>Ben G</code></p>
</td>
</tr>
<tr>
@ -64,11 +65,11 @@ to refresh data based on the ContactStore.</p>
<td class="markdown-from-sourecode">
<span class="optional">Optional</span>
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> If you will only be displaying a few results, you should pass a limit value. <a href='#searchContacts'>searchContacts</a> will return as soon as <code>limit</code> matches have been found.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -80,12 +81,12 @@ to refresh data based on the ContactStore.</p>
<h4 id=isValidContact class="function-name">
isValidContact(<span class="args"></span>) <a href="#isValidContact" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -95,4 +96,3 @@ to refresh data based on the ContactStore.</p>
contains a properly formatted email address.</p>
</td></tr>
</table>

112
docs/DatabaseStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DatabaseStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/database-store.coffee"
---
<h2>Summary</h2>
@ -52,7 +53,7 @@ are in your displayed set before refreshing.</p>
<h4 id=find class="function-name">
find(<span class="args"><span class="arg">class</span><span class="arg">id</span></span>) <a href="#find" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Creates a new Model Query for retrieving a single model specified by
the class and id.</p>
@ -62,7 +63,7 @@ are in your displayed set before refreshing.</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -74,9 +75,9 @@ are in your displayed set before refreshing.</p>
<em>class</em>
</td>
<td class="markdown-from-sourecode">
<p>The class of the <a href='model.html'>Model</a> you&#39;re trying to retrieve.</p>
</td>
</tr>
<tr>
@ -84,13 +85,13 @@ are in your displayed set before refreshing.</p>
<em>id</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> id of the <a href='model.html'>Model</a> you&#39;re trying to retrieve</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -102,13 +103,13 @@ are in your displayed set before refreshing.</p>
<h4 id=findBy class="function-name">
findBy(<span class="args"><span class="arg">class</span><span class="arg">predicates</span></span>) <a href="#findBy" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Creates a new Model Query for retrieving a single model matching the
predicates provided.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -120,9 +121,9 @@ are in your displayed set before refreshing.</p>
<em>class</em>
</td>
<td class="markdown-from-sourecode">
<p>The class of the <a href='model.html'>Model</a> you&#39;re trying to retrieve.</p>
</td>
</tr>
<tr>
@ -130,13 +131,13 @@ are in your displayed set before refreshing.</p>
<em>predicates</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> objects. The set of predicates the returned model must match.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -148,13 +149,13 @@ are in your displayed set before refreshing.</p>
<h4 id=findAll class="function-name">
findAll(<span class="args"><span class="arg">class</span><span class="arg">predicates</span></span>) <a href="#findAll" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Creates a new Model Query for retrieving all models matching the
predicates provided.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -166,9 +167,9 @@ are in your displayed set before refreshing.</p>
<em>class</em>
</td>
<td class="markdown-from-sourecode">
<p>The class of the <a href='model.html'>Model</a> you&#39;re trying to retrieve.</p>
</td>
</tr>
<tr>
@ -176,13 +177,13 @@ are in your displayed set before refreshing.</p>
<em>predicates</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> objects. The set of predicates the returned model must match.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -194,13 +195,13 @@ are in your displayed set before refreshing.</p>
<h4 id=count class="function-name">
count(<span class="args"><span class="arg">class</span><span class="arg">predicates</span></span>) <a href="#count" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Creates a new Model Query that returns the <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> of models matching
the predicates provided.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -212,9 +213,9 @@ are in your displayed set before refreshing.</p>
<em>class</em>
</td>
<td class="markdown-from-sourecode">
<p>The class of the <a href='model.html'>Model</a> you&#39;re trying to retrieve.</p>
</td>
</tr>
<tr>
@ -222,13 +223,13 @@ are in your displayed set before refreshing.</p>
<em>predicates</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> objects. The set of predicates the returned model must match.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -240,7 +241,7 @@ are in your displayed set before refreshing.</p>
<h4 id=modelify class="function-name">
modelify(<span class="args"><span class="arg">class</span><span class="arg"></span></span>) <a href="#modelify" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Modelify converts the provided array of IDs or models (or a mix of
IDs and models) into an array of models of the <code>klass</code> provided by querying for the missing items.</p>
@ -248,7 +249,7 @@ are in your displayed set before refreshing.</p>
if no query is necessary.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -260,9 +261,9 @@ are in your displayed set before refreshing.</p>
<em>class</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='model.html'>Model</a> class desired.</p>
</td>
</tr>
<tr>
@ -270,22 +271,22 @@ are in your displayed set before refreshing.</p>
<em></em>
</td>
<td class="markdown-from-sourecode">
<p>&#39;arr&#39; An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> with a mix of string model IDs and/or models.</p>
</td>
</tr>
</table>
<h4 id=run class="function-name">
run(<span class="args"><span class="arg">modelQuery</span></span>) <a href="#run" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Executes a <a href='modelquery.html'>ModelQuery</a> on the local database.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -297,13 +298,13 @@ are in your displayed set before refreshing.</p>
<em>modelQuery</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='modelquery.html'>ModelQuery</a> to execute.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -318,12 +319,12 @@ are in your displayed set before refreshing.</p>
<h4 id=persistModel class="function-name">
persistModel(<span class="args"><span class="arg">model</span></span>) <a href="#persistModel" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Asynchronously writes <code>model</code> to the cache and triggers a change event.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -335,13 +336,13 @@ are in your displayed set before refreshing.</p>
<em>model</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='model.html'>Model</a> to write to the database.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -359,13 +360,13 @@ are in your displayed set before refreshing.</p>
<h4 id=persistModels class="function-name">
persistModels(<span class="args"><span class="arg">models</span></span>) <a href="#persistModels" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Asynchronously writes <code>models</code> to the cache and triggers a single change
event. Note: Models must be of the same class to be persisted in a batch operation.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -377,13 +378,13 @@ are in your displayed set before refreshing.</p>
<em>models</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='model.html'>Model</a> objects to write to the database.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -401,12 +402,12 @@ are in your displayed set before refreshing.</p>
<h4 id=unpersistModel class="function-name">
unpersistModel(<span class="args"><span class="arg">model</span></span>) <a href="#unpersistModel" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Asynchronously removes <code>model</code> from the cache and triggers a change event.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -418,13 +419,13 @@ are in your displayed set before refreshing.</p>
<em>model</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='model.html'>Model</a> to write to the database.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -439,4 +440,3 @@ are in your displayed set before refreshing.</p>
</ul>
</td></tr>
</table>

11
docs/DatabaseView.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DatabaseView
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/database-view.coffee"
---
<h2>Summary</h2>
@ -35,7 +36,7 @@ for performance.</p>
<h4 id=invalidate class="function-name">
invalidate(<span class="args"><span class="arg">options</span></span>) <a href="#invalidate" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Call this method when the DatabaseStore triggers and will impact the
data maintained by this DatabaseView. In the future, the DatabaseView will
@ -45,7 +46,7 @@ for performance.</p>
Need a destructor...</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -57,11 +58,9 @@ for performance.</p>
<em>options</em>
</td>
<td class="markdown-from-sourecode">
<p>an Object with the following optional keys which can be used to optimize the behavior of the DatabaseView:</p>
</td>
</tr>
</table>

43
docs/DraftStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DraftStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store.coffee"
---
<h2>Summary</h2>
@ -26,7 +27,7 @@ API.</p>
<h4 id=sessionForClientId class="function-name">
sessionForClientId(<span class="args"><span class="arg">clientId</span></span>) <a href="#sessionForClientId" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Fetch a <a href='draftstoreproxy.html'>DraftStoreProxy</a> for displaying and/or editing the
draft with <code>clientId</code>.</p>
@ -37,7 +38,7 @@ API.</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -49,13 +50,13 @@ API.</p>
<em>clientId</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> clientId of the draft.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -68,23 +69,23 @@ API.</p>
<h4 id=isSendingDraft class="function-name">
isSendingDraft(<span class="args"></span>) <a href="#isSendingDraft" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Look up the sending state of the given draftClientId.
In popout windows the existance of the window is the sending state. </p>
</p>
</div>
<h4 id=extensions class="function-name">
extensions(<span class="args"></span>) <a href="#extensions" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -96,14 +97,14 @@ API.</p>
<h4 id=registerExtension class="function-name">
registerExtension(<span class="args"><span class="arg">ext</span></span>) <a href="#registerExtension" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Registers a new extension with the DraftStore. DraftStore extensions
make it possible to extend the editor experience, modify draft contents,
display warnings before draft are sent, and more.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -115,22 +116,22 @@ API.</p>
<em>ext</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='draftstoreextension.html'>DraftStoreExtension</a> instance.</p>
</td>
</tr>
</table>
<h4 id=unregisterExtension class="function-name">
unregisterExtension(<span class="args"><span class="arg">ext</span></span>) <a href="#unregisterExtension" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Unregisters the extension provided from the DraftStore.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -142,11 +143,9 @@ API.</p>
<em>ext</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='draftstoreextension.html'>DraftStoreExtension</a> instance.</p>
</td>
</tr>
</table>

110
docs/DraftStoreExtension.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DraftStoreExtension
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-extension.coffee"
---
<h2>Summary</h2>
@ -41,14 +42,14 @@ is not possible with the current API, please let us know.</p>
<h4 id=warningsForSending class="function-name">
warningsForSending(<span class="args"><span class="arg">draft</span></span>) <a href="#warningsForSending" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Inspect the draft, and return any warnings that need to be displayed before
the draft is sent. Warnings should be string phrases, such as &quot;without an attachment&quot;
that fit into a message of the form: &quot;Send #{phase1} and #{phase2}?&quot;</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -60,13 +61,13 @@ is not possible with the current API, please let us know.</p>
<em>draft</em>
</td>
<td class="markdown-from-sourecode">
<p>A fully populated <a href='message.html'>Message</a> object that is about to be sent.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -78,14 +79,14 @@ is not possible with the current API, please let us know.</p>
<h4 id=composerToolbar class="function-name">
composerToolbar(<span class="args"><span class="arg">mutator</span><span class="arg">tooltip</span><span class="arg">iconUrl</span></span>) <a href="#composerToolbar" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>declare an icon to be displayed in the composer&#39;s toolbar (where
bold, italic, underline, etc are).</p>
<p>You must declare the following properties:</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -97,9 +98,9 @@ is not possible with the current API, please let us know.</p>
<em>mutator</em>
</td>
<td class="markdown-from-sourecode">
<p>A function that&#39;s called when your toolbar button is clicked. This mutator function will be passed as its only argument the <code>dom</code>. The <code>dom</code> is the full {DOM} object of the current composer. You may mutate this in place. We don&#39;t care about the mutator&#39;s return value.</p>
</td>
</tr>
<tr>
@ -107,9 +108,9 @@ is not possible with the current API, please let us know.</p>
<em>tooltip</em>
</td>
<td class="markdown-from-sourecode">
<p>A one or two word description of what your icon does</p>
</td>
</tr>
<tr>
@ -117,17 +118,17 @@ is not possible with the current API, please let us know.</p>
<em>iconUrl</em>
</td>
<td class="markdown-from-sourecode">
<p>The url of your icon. It should be in the <code>nylas://</code> scheme. For example: <code>nylas://your-package-name/assets/my-icon@2x.png</code>. Note, we will downsample your image by 2x (for Retina screens), so make sure it&#39;s twice the resolution. The icon should be black and white. We will directly pass the <code>url</code> prop of a <a href='retinaimg.html'>RetinaImg</a></p>
</td>
</tr>
</table>
<h4 id=prepareNewDraft class="function-name">
prepareNewDraft(<span class="args"></span>) <a href="#prepareNewDraft" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Override prepareNewDraft to modify a brand new draft before it is displayed
in a composer. This is one of the only places in the application where it&#39;s safe
@ -139,12 +140,12 @@ is not possible with the current API, please let us know.</p>
<code>draft.pristine = false</code> so the draft saves, even if no further changes are made.</p>
</p>
</div>
<h4 id=finalizeSessionBeforeSending class="function-name">
finalizeSessionBeforeSending(<span class="args"><span class="arg">session</span></span>) <a href="#finalizeSessionBeforeSending" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Override finalizeSessionBeforeSending in your DraftStoreExtension subclass to transform
the <a href='draftstoreproxy.html'>DraftStoreProxy</a> editing session just before the draft is sent. This method
@ -160,7 +161,7 @@ is not possible with the current API, please let us know.</p>
</code></pre>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -172,17 +173,17 @@ is not possible with the current API, please let us know.</p>
<em>session</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='draftstoreproxy.html'>DraftStoreProxy</a> for the draft.</p>
</td>
</tr>
</table>
<h4 id=onMouseUp class="function-name">
onMouseUp(<span class="args"><span class="arg">editableNode</span><span class="arg">range</span><span class="arg">event</span></span>) <a href="#onMouseUp" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Override onMouseUp in your DraftStoreExtension subclass to
listen for mouse up events sent to the composer&#39;s body text area. This
@ -190,7 +191,7 @@ is not possible with the current API, please let us know.</p>
adjust selection ranges and change content as necessary.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -202,9 +203,9 @@ is not possible with the current API, please let us know.</p>
<em>editableNode</em>
</td>
<td class="markdown-from-sourecode">
<p>The composer&#39;s contenteditable <a href='https://developer.mozilla.org/en-US/docs/Web/API/Node'>Node</a> that received the event.</p>
</td>
</tr>
<tr>
@ -212,9 +213,9 @@ is not possible with the current API, please let us know.</p>
<em>range</em>
</td>
<td class="markdown-from-sourecode">
<p>The currently selected <a href='https://developer.mozilla.org/en-US/docs/Web/API/Range'>Range</a> in the <code>editableNode</code></p>
</td>
</tr>
<tr>
@ -222,17 +223,17 @@ is not possible with the current API, please let us know.</p>
<em>event</em>
</td>
<td class="markdown-from-sourecode">
<p>The mouse up event.</p>
</td>
</tr>
</table>
<h4 id=onFocusPrevious class="function-name">
onFocusPrevious(<span class="args"><span class="arg">editableNode</span><span class="arg">range</span><span class="arg">event</span></span>) <a href="#onFocusPrevious" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Called when the user presses <code>Shift-Tab</code> while focused on the composer&#39;s body field.
Override onFocusPrevious in your DraftStoreExtension to adjust the selection or perform
@ -240,7 +241,7 @@ is not possible with the current API, please let us know.</p>
should prevent the default behavior of Shift-Tab via <code>event.preventDefault()</code>.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -252,9 +253,9 @@ is not possible with the current API, please let us know.</p>
<em>editableNode</em>
</td>
<td class="markdown-from-sourecode">
<p>The composer&#39;s contenteditable <a href='https://developer.mozilla.org/en-US/docs/Web/API/Node'>Node</a> that received the event.</p>
</td>
</tr>
<tr>
@ -262,9 +263,9 @@ is not possible with the current API, please let us know.</p>
<em>range</em>
</td>
<td class="markdown-from-sourecode">
<p>The currently selected <a href='https://developer.mozilla.org/en-US/docs/Web/API/Range'>Range</a> in the <code>editableNode</code></p>
</td>
</tr>
<tr>
@ -272,17 +273,17 @@ is not possible with the current API, please let us know.</p>
<em>event</em>
</td>
<td class="markdown-from-sourecode">
<p>The mouse up event.</p>
</td>
</tr>
</table>
<h4 id=onFocusNext class="function-name">
onFocusNext(<span class="args"><span class="arg">editableNode</span><span class="arg">range</span><span class="arg">event</span></span>) <a href="#onFocusNext" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Called when the user presses <code>Tab</code> while focused on the composer&#39;s body field.
Override onFocusPrevious in your DraftStoreExtension to adjust the selection or perform
@ -290,7 +291,7 @@ is not possible with the current API, please let us know.</p>
should prevent the default behavior of Tab via <code>event.preventDefault()</code>.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -302,9 +303,9 @@ is not possible with the current API, please let us know.</p>
<em>editableNode</em>
</td>
<td class="markdown-from-sourecode">
<p>The composer&#39;s contenteditable <a href='https://developer.mozilla.org/en-US/docs/Web/API/Node'>Node</a> that received the event.</p>
</td>
</tr>
<tr>
@ -312,9 +313,9 @@ is not possible with the current API, please let us know.</p>
<em>range</em>
</td>
<td class="markdown-from-sourecode">
<p>The currently selected <a href='https://developer.mozilla.org/en-US/docs/Web/API/Range'>Range</a> in the <code>editableNode</code></p>
</td>
</tr>
<tr>
@ -322,17 +323,17 @@ is not possible with the current API, please let us know.</p>
<em>event</em>
</td>
<td class="markdown-from-sourecode">
<p>The mouse up event.</p>
</td>
</tr>
</table>
<h4 id=onInput class="function-name">
onInput(<span class="args"></span>) <a href="#onInput" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Override onInput in your DraftStoreExtension subclass to
implement custom behavior as the user types in the composer&#39;s
@ -345,14 +346,14 @@ is not possible with the current API, please let us know.</p>
longer empty.</p>
<pre><code class="lang-coffee">onInput: (editableNode, event) -&gt;
selection = document.<span class="hljs-function"><span class="hljs-title">getSelection</span><span class="hljs-params">()</span></span>
isWithinNode = (node) -&gt;
test = selection<span class="hljs-class">.baseNode</span>
while test isnt editableNode
return true <span class="hljs-keyword">if</span> test is node
test = test<span class="hljs-class">.parentNode</span>
return false
codeTags = editableNode.<span class="hljs-function"><span class="hljs-title">querySelectorAll</span><span class="hljs-params">(<span class="hljs-string">'code.var.empty'</span>)</span></span>
<span class="hljs-keyword">for</span> codeTag <span class="hljs-keyword">in</span> codeTags
<span class="hljs-keyword">if</span> selection.<span class="hljs-function"><span class="hljs-title">containsNode</span><span class="hljs-params">(codeTag)</span></span> or <span class="hljs-function"><span class="hljs-title">isWithinNode</span><span class="hljs-params">(codeTag)</span></span>
@ -360,8 +361,3 @@ is not possible with the current API, please let us know.</p>
</code></pre>
</p>
</div>

14
docs/DraftStoreProxy.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DraftStoreProxy
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-proxy.coffee"
---
<h2>Summary</h2>
@ -30,12 +31,12 @@ always has pending changes applied.</li>
<h4 id=draft class="function-name">
draft(<span class="args"></span>) <a href="#draft" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -47,12 +48,12 @@ always has pending changes applied.</li>
<h4 id=draftPristineBody class="function-name">
draftPristineBody(<span class="args"></span>) <a href="#draftPristineBody" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -63,4 +64,3 @@ always has pending changes applied.</li>
body is still in an unchanged / empty state.</p>
</td></tr>
</table>

6
docs/EventStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: EventStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/event-store.coffee"
---
<h2>Summary</h2>
@ -21,8 +22,3 @@ to refresh data based on the EventStore.</p>
<ul>
</ul>

48
docs/FocusedContentStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: FocusedContentStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/focused-content-store.coffee"
---
<h2>Summary</h2>
@ -53,11 +54,11 @@ have the latest version of the the selected object.</p>
<h4 id=focused class="function-name">
focused(<span class="args"><span class="arg">collection</span></span>) <a href="#focused" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -69,13 +70,13 @@ have the latest version of the the selected object.</p>
<em>collection</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of a collection. Standard collections are listed above.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -88,11 +89,11 @@ have the latest version of the the selected object.</p>
<h4 id=focusedId class="function-name">
focusedId(<span class="args"><span class="arg">collection</span></span>) <a href="#focusedId" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -104,13 +105,13 @@ have the latest version of the the selected object.</p>
<em>collection</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of a collection. Standard collections are listed above.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -123,11 +124,11 @@ have the latest version of the the selected object.</p>
<h4 id=keyboardCursor class="function-name">
keyboardCursor(<span class="args"><span class="arg">collection</span></span>) <a href="#keyboardCursor" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -139,13 +140,13 @@ have the latest version of the the selected object.</p>
<em>collection</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of a collection. Standard collections are listed above.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -160,11 +161,11 @@ have the latest version of the the selected object.</p>
<h4 id=keyboardCursorId class="function-name">
keyboardCursorId(<span class="args"><span class="arg">collection</span></span>) <a href="#keyboardCursorId" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -176,13 +177,13 @@ have the latest version of the the selected object.</p>
<em>collection</em>
</td>
<td class="markdown-from-sourecode">
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name of a collection. Standard collections are listed above.</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -197,12 +198,12 @@ have the latest version of the the selected object.</p>
<h4 id=keyboardCursorEnabled class="function-name">
keyboardCursorEnabled(<span class="args"></span>) <a href="#keyboardCursorEnabled" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -213,4 +214,3 @@ have the latest version of the the selected object.</p>
enabled in <code>list</code> mode.</p>
</td></tr>
</table>

8
docs/MessageStoreExtension.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MessageStoreExtension
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/message-store-extension.coffee"
---
<h2>Summary</h2>
@ -36,14 +37,9 @@ is not possible with the current API, please let us know.</p>
<h4 id=formatMessageBody class="function-name">
formatMessageBody(<span class="args"></span>) <a href="#formatMessageBody" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Transform the message body HTML provided in <code>body</code> and return HTML
that should be displayed for the message.</p>
</p>
</div>

16
docs/TaskQueue.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: TaskQueue
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/task-queue.coffee"
---
<h2>Summary</h2>
@ -50,11 +51,11 @@ between windows, since it&#39;s JSON serializer is not extensible.</p>
<h4 id=findTask class="function-name">
findTask(<span class="args"><span class="arg">type</span><span class="arg">matching</span></span>) <a href="#findTask" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -66,9 +67,9 @@ between windows, since it&#39;s JSON serializer is not extensible.</p>
<em>type</em>
</td>
<td class="markdown-from-sourecode">
<p>The string name of the task class, or the Task class itself. (ie: {SaveDraftTask} or &#39;SaveDraftTask&#39;)</p>
</td>
</tr>
<tr>
@ -76,13 +77,13 @@ between windows, since it&#39;s JSON serializer is not extensible.</p>
<em>matching</em>
</td>
<td class="markdown-from-sourecode">
<p>Optional An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with criteria to pass to _.isMatch. For a SaveDraftTask, this could be {draftClientId: &quot;123123&quot;}</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -95,4 +96,3 @@ between windows, since it&#39;s JSON serializer is not extensible.</p>
<tr><td class="markdown-from-sourecode"><p>Returns a matching <a href='task.html'>Task</a>, or null.</p>
</td></tr>
</table>

6
docs/TaskQueueStatusStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: TaskQueueStatusStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/task-queue-status-store.coffee"
---
<h2>Summary</h2>
@ -13,8 +14,3 @@ any window, even though the queue itself only runs in the work window.</p>
<ul>
</ul>

32
docs/WorkspaceStore.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: WorkspaceStore
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/workspace-store.coffee"
---
<h2>Summary</h2>
@ -25,12 +26,12 @@ documentation.</p>
<h4 id=topSheet class="function-name">
topSheet(<span class="args"></span>) <a href="#topSheet" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -43,12 +44,12 @@ documentation.</p>
<h4 id=rootSheet class="function-name">
rootSheet(<span class="args"></span>) <a href="#rootSheet" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -60,12 +61,12 @@ documentation.</p>
<h4 id=sheetStack class="function-name">
sheetStack(<span class="args"></span>) <a href="#sheetStack" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -77,12 +78,12 @@ documentation.</p>
<h4 id=hiddenLocations class="function-name">
hiddenLocations(<span class="args"></span>) <a href="#hiddenLocations" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -94,12 +95,12 @@ documentation.</p>
<h4 id=isLocationHidden class="function-name">
isLocationHidden(<span class="args"></span>) <a href="#isLocationHidden" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -109,4 +110,3 @@ documentation.</p>
You should provide one of the WorkspaceStore.Location constant values.</p>
</td></tr>
</table>