diff --git a/docs/AccountStore.html b/docs/AccountStore.html index 8635ec99f..7457e1bd8 100644 --- a/docs/AccountStore.html +++ b/docs/AccountStore.html @@ -1,6 +1,7 @@ --- layout: docs title: AccountStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/account-store.coffee" ---

Summary

@@ -23,12 +24,12 @@ the database and exposes the currently active Account via cur

items()

- +

- - + + Returns @@ -40,12 +41,12 @@ the database and exposes the currently active Account via cur

itemWithEmailAddress()

- +

- - + + Returns
@@ -57,12 +58,12 @@ the database and exposes the currently active Account via cur

current()

- +

- - + + Returns
@@ -71,4 +72,3 @@ the database and exposes the currently active Account via cur

Returns the currently active Account.

- diff --git a/docs/ContactStore.html b/docs/ContactStore.html index 8502c7500..02056be07 100644 --- a/docs/ContactStore.html +++ b/docs/ContactStore.html @@ -1,6 +1,7 @@ --- layout: docs title: ContactStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/contact-store.coffee" ---

Summary

@@ -33,14 +34,14 @@ to refresh data based on the ContactStore.

searchContacts(search[options])

- +

Search the user's contact list for the given search term. This method compares the search string against each Contact's name and email.

- + Parameters @@ -52,9 +53,9 @@ to refresh data based on the ContactStore.

search @@ -64,11 +65,11 @@ to refresh data based on the ContactStore.

- +

String A search phrase, such as ben@n or Ben G

- +
Optional

Object If you will only be displaying a few results, you should pass a limit value. searchContacts will return as soon as limit matches have been found.

- +
- + Returns @@ -80,12 +81,12 @@ to refresh data based on the ContactStore.

isValidContact()

- +

- - + + Returns
@@ -95,4 +96,3 @@ to refresh data based on the ContactStore.

contains a properly formatted email address.

- diff --git a/docs/DatabaseStore.html b/docs/DatabaseStore.html index 76737c182..4db5be234 100644 --- a/docs/DatabaseStore.html +++ b/docs/DatabaseStore.html @@ -1,6 +1,7 @@ --- layout: docs title: DatabaseStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/database-store.coffee" ---

Summary

@@ -52,7 +53,7 @@ are in your displayed set before refreshing.

find(classid)

- +

Creates a new Model Query for retrieving a single model specified by the class and id.

@@ -62,7 +63,7 @@ are in your displayed set before refreshing.

- + Parameters @@ -74,9 +75,9 @@ are in your displayed set before refreshing.

class @@ -84,13 +85,13 @@ are in your displayed set before refreshing.

id
- +

The class of the Model you're trying to retrieve.

- +
- +

The String id of the Model you're trying to retrieve

- +
- + Returns @@ -102,13 +103,13 @@ are in your displayed set before refreshing.

findBy(classpredicates)

- +

Creates a new Model Query for retrieving a single model matching the predicates provided.

- + Parameters
@@ -120,9 +121,9 @@ are in your displayed set before refreshing.

class @@ -130,13 +131,13 @@ are in your displayed set before refreshing.

predicates
- +

The class of the Model you're trying to retrieve.

- +
- +

An Array of matcher objects. The set of predicates the returned model must match.

- +
- + Returns @@ -148,13 +149,13 @@ are in your displayed set before refreshing.

findAll(classpredicates)

- +

Creates a new Model Query for retrieving all models matching the predicates provided.

- + Parameters
@@ -166,9 +167,9 @@ are in your displayed set before refreshing.

class @@ -176,13 +177,13 @@ are in your displayed set before refreshing.

predicates
- +

The class of the Model you're trying to retrieve.

- +
- +

An Array of matcher objects. The set of predicates the returned model must match.

- +
- + Returns @@ -194,13 +195,13 @@ are in your displayed set before refreshing.

count(classpredicates)

- +

Creates a new Model Query that returns the Number of models matching the predicates provided.

- + Parameters
@@ -212,9 +213,9 @@ are in your displayed set before refreshing.

class @@ -222,13 +223,13 @@ are in your displayed set before refreshing.

predicates
- +

The class of the Model you're trying to retrieve.

- +
- +

An Array of matcher objects. The set of predicates the returned model must match.

- +
- + Returns @@ -240,7 +241,7 @@ are in your displayed set before refreshing.

modelify(class)

- +

Modelify converts the provided array of IDs or models (or a mix of IDs and models) into an array of models of the klass provided by querying for the missing items.

@@ -248,7 +249,7 @@ are in your displayed set before refreshing.

if no query is necessary.

- + Parameters
@@ -260,9 +261,9 @@ are in your displayed set before refreshing.

class @@ -270,22 +271,22 @@ are in your displayed set before refreshing.

- +

The Model class desired.

- +
- +

'arr' An Array with a mix of string model IDs and/or models.

- +
- +

run(modelQuery)

- +

Executes a ModelQuery on the local database.

- + Parameters @@ -297,13 +298,13 @@ are in your displayed set before refreshing.

modelQuery
- +

A ModelQuery to execute.

- +
- + Returns @@ -318,12 +319,12 @@ are in your displayed set before refreshing.

persistModel(model)

- +

Asynchronously writes model to the cache and triggers a change event.

- + Parameters
@@ -335,13 +336,13 @@ are in your displayed set before refreshing.

model
- +

A Model to write to the database.

- +
- + Returns @@ -359,13 +360,13 @@ are in your displayed set before refreshing.

persistModels(models)

- +

Asynchronously writes models to the cache and triggers a single change event. Note: Models must be of the same class to be persisted in a batch operation.

- + Parameters
@@ -377,13 +378,13 @@ are in your displayed set before refreshing.

models
- +

An Array of Model objects to write to the database.

- +
- + Returns @@ -401,12 +402,12 @@ are in your displayed set before refreshing.

unpersistModel(model)

- +

Asynchronously removes model from the cache and triggers a change event.

- + Parameters
@@ -418,13 +419,13 @@ are in your displayed set before refreshing.

model
- +

A Model to write to the database.

- +
- + Returns @@ -439,4 +440,3 @@ are in your displayed set before refreshing.

- diff --git a/docs/DatabaseView.html b/docs/DatabaseView.html index d9654b372..885d26b0b 100644 --- a/docs/DatabaseView.html +++ b/docs/DatabaseView.html @@ -1,6 +1,7 @@ --- layout: docs title: DatabaseView +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/database-view.coffee" ---

Summary

@@ -35,7 +36,7 @@ for performance.

invalidate(options)

- +

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.

Need a destructor...

- + Parameters @@ -57,11 +58,9 @@ for performance.

options
- +

an Object with the following optional keys which can be used to optimize the behavior of the DatabaseView:

- +
- - diff --git a/docs/DraftStore.html b/docs/DraftStore.html index 1f8a66191..e22ea3cfb 100644 --- a/docs/DraftStore.html +++ b/docs/DraftStore.html @@ -1,6 +1,7 @@ --- layout: docs title: DraftStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store.coffee" ---

Summary

@@ -26,7 +27,7 @@ API.

sessionForClientId(clientId)

- +

Fetch a DraftStoreProxy for displaying and/or editing the draft with clientId.

@@ -37,7 +38,7 @@ API.

- + Parameters @@ -49,13 +50,13 @@ API.

clientId
- +

The String clientId of the draft.

- +
- + Returns @@ -68,23 +69,23 @@ API.

isSendingDraft()

- +

Look up the sending state of the given draftClientId. In popout windows the existance of the window is the sending state.

- - + +

extensions()

- +

- - + + Returns
@@ -96,14 +97,14 @@ API.

registerExtension(ext)

- +

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.

- + Parameters
@@ -115,22 +116,22 @@ API.

ext
- +

A DraftStoreExtension instance.

- +
- +

unregisterExtension(ext)

- +

Unregisters the extension provided from the DraftStore.

- + Parameters @@ -142,11 +143,9 @@ API.

ext
- +

A DraftStoreExtension instance.

- +
- - diff --git a/docs/DraftStoreExtension.html b/docs/DraftStoreExtension.html index 449960fe6..fb574479a 100644 --- a/docs/DraftStoreExtension.html +++ b/docs/DraftStoreExtension.html @@ -1,6 +1,7 @@ --- layout: docs title: DraftStoreExtension +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-extension.coffee" ---

Summary

@@ -41,14 +42,14 @@ is not possible with the current API, please let us know.

warningsForSending(draft)

- +

Inspect the draft, and return any warnings that need to be displayed before the draft is sent. Warnings should be string phrases, such as "without an attachment" that fit into a message of the form: "Send #{phase1} and #{phase2}?"

- + Parameters @@ -60,13 +61,13 @@ is not possible with the current API, please let us know.

draft
- +

A fully populated Message object that is about to be sent.

- +
- + Returns @@ -78,14 +79,14 @@ is not possible with the current API, please let us know.

composerToolbar(mutatortooltipiconUrl)

- +

declare an icon to be displayed in the composer's toolbar (where bold, italic, underline, etc are).

You must declare the following properties:

- + Parameters
@@ -97,9 +98,9 @@ is not possible with the current API, please let us know.

mutator @@ -107,9 +108,9 @@ is not possible with the current API, please let us know.

tooltip @@ -117,17 +118,17 @@ is not possible with the current API, please let us know.

iconUrl
- +

A function that's called when your toolbar button is clicked. This mutator function will be passed as its only argument the dom. The dom is the full {DOM} object of the current composer. You may mutate this in place. We don't care about the mutator's return value.

- +
- +

A one or two word description of what your icon does

- +
- +

The url of your icon. It should be in the nylas:// scheme. For example: nylas://your-package-name/assets/my-icon@2x.png. Note, we will downsample your image by 2x (for Retina screens), so make sure it's twice the resolution. The icon should be black and white. We will directly pass the url prop of a RetinaImg

- +
- +

prepareNewDraft()

- +

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's safe @@ -139,12 +140,12 @@ is not possible with the current API, please let us know.

draft.pristine = false so the draft saves, even if no further changes are made.

- - + +

finalizeSessionBeforeSending(session)

- +

Override finalizeSessionBeforeSending in your DraftStoreExtension subclass to transform the DraftStoreProxy 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.

- + Parameters @@ -172,17 +173,17 @@ is not possible with the current API, please let us know.

session
- +

A DraftStoreProxy for the draft.

- +
- +

onMouseUp(editableNoderangeevent)

- +

Override onMouseUp in your DraftStoreExtension subclass to listen for mouse up events sent to the composer's body text area. This @@ -190,7 +191,7 @@ is not possible with the current API, please let us know.

adjust selection ranges and change content as necessary.

- + Parameters @@ -202,9 +203,9 @@ is not possible with the current API, please let us know.

editableNode @@ -212,9 +213,9 @@ is not possible with the current API, please let us know.

range @@ -222,17 +223,17 @@ is not possible with the current API, please let us know.

event
- +

The composer's contenteditable Node that received the event.

- +
- +

The currently selected Range in the editableNode

- +
- +

The mouse up event.

- +
- +

onFocusPrevious(editableNoderangeevent)

- +

Called when the user presses Shift-Tab while focused on the composer'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.

should prevent the default behavior of Shift-Tab via event.preventDefault().

- + Parameters @@ -252,9 +253,9 @@ is not possible with the current API, please let us know.

editableNode @@ -262,9 +263,9 @@ is not possible with the current API, please let us know.

range @@ -272,17 +273,17 @@ is not possible with the current API, please let us know.

event
- +

The composer's contenteditable Node that received the event.

- +
- +

The currently selected Range in the editableNode

- +
- +

The mouse up event.

- +
- +

onFocusNext(editableNoderangeevent)

- +

Called when the user presses Tab while focused on the composer'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.

should prevent the default behavior of Tab via event.preventDefault().

- + Parameters @@ -302,9 +303,9 @@ is not possible with the current API, please let us know.

editableNode @@ -312,9 +313,9 @@ is not possible with the current API, please let us know.

range @@ -322,17 +323,17 @@ is not possible with the current API, please let us know.

event
- +

The composer's contenteditable Node that received the event.

- +
- +

The currently selected Range in the editableNode

- +
- +

The mouse up event.

- +
- +

onInput()

- +

Override onInput in your DraftStoreExtension subclass to implement custom behavior as the user types in the composer's @@ -345,14 +346,14 @@ is not possible with the current API, please let us know.

longer empty.

onInput: (editableNode, event) ->
       selection = document.getSelection()
-    
+
       isWithinNode = (node) ->
         test = selection.baseNode
         while test isnt editableNode
           return true if test is node
           test = test.parentNode
         return false
-    
+
       codeTags = editableNode.querySelectorAll('code.var.empty')
       for codeTag in codeTags
         if selection.containsNode(codeTag) or isWithinNode(codeTag)
@@ -360,8 +361,3 @@ is not possible with the current API, please let us know.

- - - - - diff --git a/docs/DraftStoreProxy.html b/docs/DraftStoreProxy.html index dbcff35af..a75568dc0 100644 --- a/docs/DraftStoreProxy.html +++ b/docs/DraftStoreProxy.html @@ -1,6 +1,7 @@ --- layout: docs title: DraftStoreProxy +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-proxy.coffee" ---

Summary

@@ -30,12 +31,12 @@ always has pending changes applied.

draft()

- +

- - + + Returns @@ -47,12 +48,12 @@ always has pending changes applied.

draftPristineBody()

- +

- - + + Returns
@@ -63,4 +64,3 @@ always has pending changes applied. body is still in an unchanged / empty state.

- diff --git a/docs/EventStore.html b/docs/EventStore.html index b327da6c8..837b777e3 100644 --- a/docs/EventStore.html +++ b/docs/EventStore.html @@ -1,6 +1,7 @@ --- layout: docs title: EventStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/event-store.coffee" ---

Summary

@@ -21,8 +22,3 @@ to refresh data based on the EventStore.

- - - - - diff --git a/docs/FocusedContentStore.html b/docs/FocusedContentStore.html index b4490093b..7ae887451 100644 --- a/docs/FocusedContentStore.html +++ b/docs/FocusedContentStore.html @@ -1,6 +1,7 @@ --- layout: docs title: FocusedContentStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/focused-content-store.coffee" ---

Summary

@@ -53,11 +54,11 @@ have the latest version of the the selected object.

focused(collection)

- +

- + Parameters @@ -69,13 +70,13 @@ have the latest version of the the selected object.

collection
- +

The String name of a collection. Standard collections are listed above.

- +
- + Returns @@ -88,11 +89,11 @@ have the latest version of the the selected object.

focusedId(collection)

- +

- + Parameters
@@ -104,13 +105,13 @@ have the latest version of the the selected object.

collection
- +

The String name of a collection. Standard collections are listed above.

- +
- + Returns @@ -123,11 +124,11 @@ have the latest version of the the selected object.

keyboardCursor(collection)

- +

- + Parameters
@@ -139,13 +140,13 @@ have the latest version of the the selected object.

collection
- +

The String name of a collection. Standard collections are listed above.

- +
- + Returns @@ -160,11 +161,11 @@ have the latest version of the the selected object.

keyboardCursorId(collection)

- +

- + Parameters
@@ -176,13 +177,13 @@ have the latest version of the the selected object.

collection
- +

The String name of a collection. Standard collections are listed above.

- +
- + Returns @@ -197,12 +198,12 @@ have the latest version of the the selected object.

keyboardCursorEnabled()

- +

- - + + Returns
@@ -213,4 +214,3 @@ have the latest version of the the selected object.

enabled in list mode.

- diff --git a/docs/MessageStoreExtension.html b/docs/MessageStoreExtension.html index 4d9c18e68..2c5e480a4 100644 --- a/docs/MessageStoreExtension.html +++ b/docs/MessageStoreExtension.html @@ -1,6 +1,7 @@ --- layout: docs title: MessageStoreExtension +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/message-store-extension.coffee" ---

Summary

@@ -36,14 +37,9 @@ is not possible with the current API, please let us know.

formatMessageBody()

- +

Transform the message body HTML provided in body and return HTML that should be displayed for the message.

- - - - - diff --git a/docs/TaskQueue.html b/docs/TaskQueue.html index 8389b21f4..a9d9c4e80 100644 --- a/docs/TaskQueue.html +++ b/docs/TaskQueue.html @@ -1,6 +1,7 @@ --- layout: docs title: TaskQueue +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/task-queue.coffee" ---

Summary

@@ -50,11 +51,11 @@ between windows, since it's JSON serializer is not extensible.

findTask(typematching)

- +

- + Parameters @@ -66,9 +67,9 @@ between windows, since it's JSON serializer is not extensible.

type @@ -76,13 +77,13 @@ between windows, since it's JSON serializer is not extensible.

matching
- +

The string name of the task class, or the Task class itself. (ie: {SaveDraftTask} or 'SaveDraftTask')

- +
- +

Optional An Object with criteria to pass to _.isMatch. For a SaveDraftTask, this could be {draftClientId: "123123"}

- +
- + Returns @@ -95,4 +96,3 @@ between windows, since it's JSON serializer is not extensible.

Returns a matching Task, or null.

- diff --git a/docs/TaskQueueStatusStore.html b/docs/TaskQueueStatusStore.html index c026bbe34..8458e862b 100644 --- a/docs/TaskQueueStatusStore.html +++ b/docs/TaskQueueStatusStore.html @@ -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" ---

Summary

@@ -13,8 +14,3 @@ any window, even though the queue itself only runs in the work window.

- - - - - diff --git a/docs/WorkspaceStore.html b/docs/WorkspaceStore.html index 0ebc01b8a..8563950fc 100644 --- a/docs/WorkspaceStore.html +++ b/docs/WorkspaceStore.html @@ -1,6 +1,7 @@ --- layout: docs title: WorkspaceStore +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/workspace-store.coffee" ---

Summary

@@ -25,12 +26,12 @@ documentation.

topSheet()

- +

- - + + Returns @@ -43,12 +44,12 @@ documentation.

rootSheet()

- +

- - + + Returns
@@ -60,12 +61,12 @@ documentation.

sheetStack()

- +

- - + + Returns
@@ -77,12 +78,12 @@ documentation.

hiddenLocations()

- +

- - + + Returns
@@ -94,12 +95,12 @@ documentation.

isLocationHidden()

- +

- - + + Returns
@@ -109,4 +110,3 @@ documentation.

You should provide one of the WorkspaceStore.Location constant values.

-