mirror of
https://github.com/Foundry376/Mailspring.git
synced 2024-09-23 00:36:50 +08:00
1942 lines
51 KiB
HTML
1942 lines
51 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>NylasEnvConstructor · Nylas Mail Plugin SDK</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.2">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-anchors/plugin.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../styles/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="QueryResultSet.html" />
|
|
|
|
|
|
<link rel="prev" href="KeyCommandsRegion.html" />
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href='../img/favicon.png' type="image/x-icon">
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" >
|
|
|
|
<span>
|
|
|
|
|
|
Nylas Mail SDK Guides
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="../guides/GettingStarted.html">
|
|
|
|
<a href="../guides/GettingStarted.html">
|
|
|
|
|
|
Getting Started
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" data-path="../guides/GettingStarted-2.html">
|
|
|
|
<a href="../guides/GettingStarted-2.html">
|
|
|
|
|
|
Getting Started Part 2
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5" data-path="../guides/PackageOverview.html">
|
|
|
|
<a href="../guides/PackageOverview.html">
|
|
|
|
|
|
Building a Package
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="../guides/InterfaceConcepts.html">
|
|
|
|
<a href="../guides/InterfaceConcepts.html">
|
|
|
|
|
|
Interface Concepts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7" data-path="../guides/React.html">
|
|
|
|
<a href="../guides/React.html">
|
|
|
|
|
|
UI Components
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.8" data-path="../guides/Architecture.html">
|
|
|
|
<a href="../guides/Architecture.html">
|
|
|
|
|
|
Application Architecture
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.9" data-path="../guides/Debugging.html">
|
|
|
|
<a href="../guides/Debugging.html">
|
|
|
|
|
|
Debugging Nylas Mail
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.10" data-path="../guides/Database.html">
|
|
|
|
<a href="../guides/Database.html">
|
|
|
|
|
|
Accessing the Database
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.11" data-path="../guides/ComposerExtensions.html">
|
|
|
|
<a href="../guides/ComposerExtensions.html">
|
|
|
|
|
|
Extending the Composer
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.12" data-path="../guides/WritingSpecs.html">
|
|
|
|
<a href="../guides/WritingSpecs.html">
|
|
|
|
|
|
Writing Tests
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.13" data-path="../guides/IntegrationTesting.html">
|
|
|
|
<a href="../guides/IntegrationTesting.html">
|
|
|
|
|
|
Integration Testing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.14" data-path="../guides/Windows.html">
|
|
|
|
<a href="../guides/Windows.html">
|
|
|
|
|
|
Developing on Windows
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.15" data-path="../guides/FAQ.html">
|
|
|
|
<a href="../guides/FAQ.html">
|
|
|
|
|
|
FAQ
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Full Class Reference</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" >
|
|
|
|
<span>
|
|
|
|
|
|
General
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.1.1" data-path="Actions.html">
|
|
|
|
<a href="Actions.html">
|
|
|
|
|
|
Actions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.2" data-path="BufferedProcess.html">
|
|
|
|
<a href="BufferedProcess.html">
|
|
|
|
|
|
BufferedProcess
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.3" data-path="ChangeFolderTask.html">
|
|
|
|
<a href="ChangeFolderTask.html">
|
|
|
|
|
|
ChangeFolderTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.4" data-path="ChangeLabelsTask.html">
|
|
|
|
<a href="ChangeLabelsTask.html">
|
|
|
|
|
|
ChangeLabelsTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.5" data-path="ChangeMailTask.html">
|
|
|
|
<a href="ChangeMailTask.html">
|
|
|
|
|
|
ChangeMailTask
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.6" data-path="Color.html">
|
|
|
|
<a href="Color.html">
|
|
|
|
|
|
Color
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.7" data-path="Config.html">
|
|
|
|
<a href="Config.html">
|
|
|
|
|
|
Config
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.8" data-path="Contenteditable.html">
|
|
|
|
<a href="Contenteditable.html">
|
|
|
|
|
|
Contenteditable
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.9" data-path="KeyCommandsRegion.html">
|
|
|
|
<a href="KeyCommandsRegion.html">
|
|
|
|
|
|
KeyCommandsRegion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="2.1.10" data-path="NylasEnvConstructor.html">
|
|
|
|
<a href="NylasEnvConstructor.html">
|
|
|
|
|
|
NylasEnvConstructor
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.11" data-path="QueryResultSet.html">
|
|
|
|
<a href="QueryResultSet.html">
|
|
|
|
|
|
QueryResultSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.12" data-path="QuerySubscriptionPool.html">
|
|
|
|
<a href="QuerySubscriptionPool.html">
|
|
|
|
|
|
QuerySubscriptionPool
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.13" data-path="StyleManager.html">
|
|
|
|
<a href="StyleManager.html">
|
|
|
|
|
|
StyleManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.14" data-path="Task.html">
|
|
|
|
<a href="Task.html">
|
|
|
|
|
|
Task
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.15" data-path="TaskQueueStatusStore.html">
|
|
|
|
<a href="TaskQueueStatusStore.html">
|
|
|
|
|
|
TaskQueueStatusStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.16" data-path="ThemeManager.html">
|
|
|
|
<a href="ThemeManager.html">
|
|
|
|
|
|
ThemeManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" >
|
|
|
|
<span>
|
|
|
|
|
|
Component Kit
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.2.1" data-path="EventedIFrame.html">
|
|
|
|
<a href="EventedIFrame.html">
|
|
|
|
|
|
EventedIFrame
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.2" data-path="Flexbox.html">
|
|
|
|
<a href="Flexbox.html">
|
|
|
|
|
|
Flexbox
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.3" data-path="InjectedComponent.html">
|
|
|
|
<a href="InjectedComponent.html">
|
|
|
|
|
|
InjectedComponent
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.4" data-path="InjectedComponentSet.html">
|
|
|
|
<a href="InjectedComponentSet.html">
|
|
|
|
|
|
InjectedComponentSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.5" data-path="Menu.html">
|
|
|
|
<a href="Menu.html">
|
|
|
|
|
|
Menu
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.6" data-path="MenuItem.html">
|
|
|
|
<a href="MenuItem.html">
|
|
|
|
|
|
MenuItem
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.7" data-path="MenuNameEmailItem.html">
|
|
|
|
<a href="MenuNameEmailItem.html">
|
|
|
|
|
|
MenuNameEmailItem
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.8" data-path="MultiselectActionBar.html">
|
|
|
|
<a href="MultiselectActionBar.html">
|
|
|
|
|
|
MultiselectActionBar
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.9" data-path="MultiselectList.html">
|
|
|
|
<a href="MultiselectList.html">
|
|
|
|
|
|
MultiselectList
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.10" data-path="ResizableRegion.html">
|
|
|
|
<a href="ResizableRegion.html">
|
|
|
|
|
|
ResizableRegion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.11" data-path="RetinaImg.html">
|
|
|
|
<a href="RetinaImg.html">
|
|
|
|
|
|
RetinaImg
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.12" data-path="Spinner.html">
|
|
|
|
<a href="Spinner.html">
|
|
|
|
|
|
Spinner
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.13" data-path="UnsafeComponent.html">
|
|
|
|
<a href="UnsafeComponent.html">
|
|
|
|
|
|
UnsafeComponent
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3" >
|
|
|
|
<span>
|
|
|
|
|
|
Extensions
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.3.1" data-path="ComposerExtension.html">
|
|
|
|
<a href="ComposerExtension.html">
|
|
|
|
|
|
ComposerExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.2" data-path="ContenteditableExtension.html">
|
|
|
|
<a href="ContenteditableExtension.html">
|
|
|
|
|
|
ContenteditableExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.3" data-path="DraftStoreExtension.html">
|
|
|
|
<a href="DraftStoreExtension.html">
|
|
|
|
|
|
DraftStoreExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.4" data-path="MessageStoreExtension.html">
|
|
|
|
<a href="MessageStoreExtension.html">
|
|
|
|
|
|
MessageStoreExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3.5" data-path="MessageViewExtension.html">
|
|
|
|
<a href="MessageViewExtension.html">
|
|
|
|
|
|
MessageViewExtension
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4" >
|
|
|
|
<span>
|
|
|
|
|
|
Models
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.4.1" data-path="Contact.html">
|
|
|
|
<a href="Contact.html">
|
|
|
|
|
|
Contact
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.2" data-path="Message.html">
|
|
|
|
<a href="Message.html">
|
|
|
|
|
|
Message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.3" data-path="Model.html">
|
|
|
|
<a href="Model.html">
|
|
|
|
|
|
Model
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4.4" data-path="Thread.html">
|
|
|
|
<a href="Thread.html">
|
|
|
|
|
|
Thread
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5" >
|
|
|
|
<span>
|
|
|
|
|
|
Stores
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.5.1" data-path="AccountStore.html">
|
|
|
|
<a href="AccountStore.html">
|
|
|
|
|
|
AccountStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.2" data-path="ComponentRegistry.html">
|
|
|
|
<a href="ComponentRegistry.html">
|
|
|
|
|
|
ComponentRegistry
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.3" data-path="ContactStore.html">
|
|
|
|
<a href="ContactStore.html">
|
|
|
|
|
|
ContactStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.4" data-path="FocusedContentStore.html">
|
|
|
|
<a href="FocusedContentStore.html">
|
|
|
|
|
|
FocusedContentStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.5" data-path="TaskQueue.html">
|
|
|
|
<a href="TaskQueue.html">
|
|
|
|
|
|
TaskQueue
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5.6" data-path="WorkspaceStore.html">
|
|
|
|
<a href="WorkspaceStore.html">
|
|
|
|
|
|
WorkspaceStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6" >
|
|
|
|
<span>
|
|
|
|
|
|
Database
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.6.1" data-path="Attribute.html">
|
|
|
|
<a href="Attribute.html">
|
|
|
|
|
|
Attribute
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.2" data-path="AttributeBoolean.html">
|
|
|
|
<a href="AttributeBoolean.html">
|
|
|
|
|
|
AttributeBoolean
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.3" data-path="AttributeCollection.html">
|
|
|
|
<a href="AttributeCollection.html">
|
|
|
|
|
|
AttributeCollection
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.4" data-path="AttributeDateTime.html">
|
|
|
|
<a href="AttributeDateTime.html">
|
|
|
|
|
|
AttributeDateTime
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.5" data-path="AttributeJoinedData.html">
|
|
|
|
<a href="AttributeJoinedData.html">
|
|
|
|
|
|
AttributeJoinedData
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.6" data-path="AttributeNumber.html">
|
|
|
|
<a href="AttributeNumber.html">
|
|
|
|
|
|
AttributeNumber
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.7" data-path="AttributeObject.html">
|
|
|
|
<a href="AttributeObject.html">
|
|
|
|
|
|
AttributeObject
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.8" data-path="AttributeServerId.html">
|
|
|
|
<a href="AttributeServerId.html">
|
|
|
|
|
|
AttributeServerId
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.9" data-path="AttributeString.html">
|
|
|
|
<a href="AttributeString.html">
|
|
|
|
|
|
AttributeString
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.10" data-path="DatabaseStore.html">
|
|
|
|
<a href="DatabaseStore.html">
|
|
|
|
|
|
DatabaseStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.11" data-path="Matcher.html">
|
|
|
|
<a href="Matcher.html">
|
|
|
|
|
|
Matcher
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.12" data-path="ModelQuery.html">
|
|
|
|
<a href="ModelQuery.html">
|
|
|
|
|
|
ModelQuery
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6.13" data-path="SortOrder.html">
|
|
|
|
<a href="SortOrder.html">
|
|
|
|
|
|
SortOrder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7" >
|
|
|
|
<span>
|
|
|
|
|
|
Drafts
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.7.1" data-path="DraftChangeSet.html">
|
|
|
|
<a href="DraftChangeSet.html">
|
|
|
|
|
|
DraftChangeSet
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7.2" data-path="DraftEditingSession.html">
|
|
|
|
<a href="DraftEditingSession.html">
|
|
|
|
|
|
DraftEditingSession
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7.3" data-path="DraftStore.html">
|
|
|
|
<a href="DraftStore.html">
|
|
|
|
|
|
DraftStore
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.8" >
|
|
|
|
<span>
|
|
|
|
|
|
NylasEnv
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.8.1" data-path="PackageManager.html">
|
|
|
|
<a href="PackageManager.html">
|
|
|
|
|
|
PackageManager
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.9" >
|
|
|
|
<span>
|
|
|
|
|
|
Atom
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >NylasEnvConstructor</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="nylasenvconstructor"><a name="nylasenvconstructor" class="plugin-anchor" href="#nylasenvconstructor"><i class="fa fa-link" aria-hidden="true"></i></a>NylasEnvConstructor</h1>
|
|
<h2 id="summary"><a name="summary" class="plugin-anchor" href="#summary"><i class="fa fa-link" aria-hidden="true"></i></a>Summary</h2>
|
|
<p>NylasEnv global for dealing with packages, themes, menus, and the window.</p>
|
|
<p>The singleton of this class is always available as the <code>NylasEnv</code> global. </p>
|
|
<ul>
|
|
<li><a href="#Properties">Properties</a></li>
|
|
<li><a href="#Construction%20and%20Destruction">Construction and Destruction</a></li>
|
|
<li><a href="#Event%20Subscription">Event Subscription</a></li>
|
|
<li><a href="#Managing%20The%20Nylas%20Window">Managing The Nylas Window</a></li>
|
|
<li><a href="#Messaging%20the%20User">Messaging the User</a></li>
|
|
<li><a href="#Managing%20the%20Dev%20Tools">Managing the Dev Tools</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="instance-methods"><a name="instance-methods" class="plugin-anchor" href="#instance-methods"><i class="fa fa-link" aria-hidden="true"></i></a>Instance Methods</h3>
|
|
<h4 id="reportError" class="function-name"><a name="reportError" class="plugin-anchor" href="#reportError"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
reportError(<span class="args"></span>) <a href="#reportError" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>report an error through the `ErrorLogger`
|
|
|
|
Takes an error and an extra object to report. Hooks into the
|
|
`onWillThrowError` and `onDidThrowError` callbacks. If someone
|
|
registered with `onWillThrowError` calls `preventDefault` on the event
|
|
object it's given, then no error will be reported.
|
|
|
|
The difference between this and `ErrorLogger.reportError` is that
|
|
`NylasEnv.reportError` will hook into the event callbacks and handle
|
|
test failures and dev tool popups. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="onDidBeep" class="function-name"><a name="onDidBeep" class="plugin-anchor" href="#onDidBeep"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
onDidBeep(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidBeep" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Invoke the given callback whenever <a href="#beep">beep</a> is called.</p>
|
|
</div>
|
|
|
|
<p><strong>Parameters</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>callback</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
{Function} to be called whenever <a href="#beep">beep</a> is called.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Returns</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.</td></tr>
|
|
</table>
|
|
<h4 id="onWillThrowError" class="function-name"><a name="onWillThrowError" class="plugin-anchor" href="#onWillThrowError"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
onWillThrowError(<span class="args"><span class="arg">callback</span></span>) <a href="#onWillThrowError" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Invoke the given callback when there is an unhandled error, but
|
|
before the devtools pop open</p>
|
|
</div>
|
|
|
|
<strong>Parameters</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>callback</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
{Function} to be called whenever there is an unhandled error
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Returns</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.</td></tr>
|
|
</table>
|
|
<h4 id="onDidThrowError" class="function-name"><a name="onDidThrowError" class="plugin-anchor" href="#onDidThrowError"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
onDidThrowError(<span class="args"><span class="arg">callback</span></span>) <a href="#onDidThrowError" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Invoke the given callback whenever there is an unhandled error.</p>
|
|
</div>
|
|
|
|
<strong>Parameters</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>callback</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
{Function} to be called whenever there is an unhandled error
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Returns</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.</td></tr>
|
|
</table>
|
|
<h4 id="trace" class="function-name"><a name="trace" class="plugin-anchor" href="#trace"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
trace(<span class="args"></span>) <a href="#trace" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Run the Chromium content-tracing module for five seconds, and save
|
|
the output to a file which is printed to the command-line output of the app.
|
|
You can take the file exported by this function and load it into Chrome's
|
|
content trace visualizer (chrome://tracing). It's like Chromium Developer
|
|
Tools Profiler, but for all processes and threads. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="inDevMode" class="function-name"><a name="inDevMode" class="plugin-anchor" href="#inDevMode"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
inDevMode(<span class="args"></span>) <a href="#inDevMode" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Is the current window in development mode? </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="inSafeMode" class="function-name"><a name="inSafeMode" class="plugin-anchor" href="#inSafeMode"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
inSafeMode(<span class="args"></span>) <a href="#inSafeMode" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Is the current window in safe mode? </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="inSpecMode" class="function-name"><a name="inSpecMode" class="plugin-anchor" href="#inSpecMode"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
inSpecMode(<span class="args"></span>) <a href="#inSpecMode" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Is the current window running specs? </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="getVersion" class="function-name"><a name="getVersion" class="plugin-anchor" href="#getVersion"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getVersion(<span class="args"></span>) <a href="#getVersion" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Get the version of N1.</p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns the version text {String}.</td></tr>
|
|
</table>
|
|
<h4 id="isReleasedVersion" class="function-name"><a name="isReleasedVersion" class="plugin-anchor" href="#isReleasedVersion"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
isReleasedVersion(<span class="args"></span>) <a href="#isReleasedVersion" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Determine whether the current version is an official release. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="getConfigDirPath" class="function-name"><a name="getConfigDirPath" class="plugin-anchor" href="#getConfigDirPath"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getConfigDirPath(<span class="args"></span>) <a href="#getConfigDirPath" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Get the directory path to N1's configuration area. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="getWindowLoadTime" class="function-name"><a name="getWindowLoadTime" class="plugin-anchor" href="#getWindowLoadTime"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getWindowLoadTime(<span class="args"></span>) <a href="#getWindowLoadTime" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Get the time taken to completely load the current window.
|
|
|
|
This time include things like loading and activating packages, creating
|
|
DOM elements for the editor, and reading the config.</p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns the {Number} of milliseconds taken to load the window or null
|
|
if the window hasn't finished loading yet.</td></tr>
|
|
</table>
|
|
<h4 id="close" class="function-name"><a name="close" class="plugin-anchor" href="#close"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
close(<span class="args"></span>) <a href="#close" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Close the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="getSize" class="function-name"><a name="getSize" class="plugin-anchor" href="#getSize"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getSize(<span class="args"></span>) <a href="#getSize" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Get the size of current window.</p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns an {Object} in the format `{width: 1000, height: 700}`</td></tr>
|
|
</table>
|
|
<h4 id="setSize" class="function-name"><a name="setSize" class="plugin-anchor" href="#setSize"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
setSize(<span class="args"><span class="arg">width</span><span class="arg">height</span></span>) <a href="#setSize" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Set the size of current window.</p>
|
|
</div>
|
|
|
|
<strong>Parameters</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>width</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>height</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h4 id="setSizeAnimated" class="function-name"><a name="setSizeAnimated" class="plugin-anchor" href="#setSizeAnimated"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
setSizeAnimated(<span class="args"><span class="arg">width</span><span class="arg">height</span><span class="arg">duration</span></span>) <a href="#setSizeAnimated" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Transition and set the size of the current window.</p>
|
|
</div>
|
|
|
|
<p><strong>Parameters</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>width</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>height</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>duration</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h4 id="getPosition" class="function-name"><a name="getPosition" class="plugin-anchor" href="#getPosition"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getPosition(<span class="args"></span>) <a href="#getPosition" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Get the position of current window.</p>
|
|
</div>
|
|
|
|
|
|
<p><strong>Returns</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns an {Object} in the format `{x: 10, y: 20}`</td></tr>
|
|
</table>
|
|
<h4 id="setPosition" class="function-name"><a name="setPosition" class="plugin-anchor" href="#setPosition"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
setPosition(<span class="args"><span class="arg">x</span><span class="arg">y</span></span>) <a href="#setPosition" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Set the position of current window.</p>
|
|
</div>
|
|
|
|
<strong>Parameters</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>x</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>y</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
The {Number} of pixels.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h4 id="center" class="function-name"><a name="center" class="plugin-anchor" href="#center"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
center(<span class="args"></span>) <a href="#center" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Move current window to the center of the screen. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="focus" class="function-name"><a name="focus" class="plugin-anchor" href="#focus"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
focus(<span class="args"></span>) <a href="#focus" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Focus the current window. Note: this will not open the window
|
|
if it is hidden. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="show" class="function-name"><a name="show" class="plugin-anchor" href="#show"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
show(<span class="args"></span>) <a href="#show" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Show the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="hide" class="function-name"><a name="hide" class="plugin-anchor" href="#hide"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
hide(<span class="args"></span>) <a href="#hide" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Hide the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="reload" class="function-name"><a name="reload" class="plugin-anchor" href="#reload"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
reload(<span class="args"></span>) <a href="#reload" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Reload the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="getWindowProps" class="function-name"><a name="getWindowProps" class="plugin-anchor" href="#getWindowProps"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
getWindowProps(<span class="args"></span>) <a href="#getWindowProps" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>The windowProps passed when creating the window via `newWindow`.</p>
|
|
</div>
|
|
|
|
|
|
<h4 id="onWindowPropsReceived" class="function-name"><a name="onWindowPropsReceived" class="plugin-anchor" href="#onWindowPropsReceived"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
onWindowPropsReceived(<span class="args"></span>) <a href="#onWindowPropsReceived" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>If your package declares hot-loaded window types, `onWindowPropsReceived`
|
|
fires when your hot-loaded window is about to be shown so you can update
|
|
components to reflect the new window props.
|
|
|
|
* callback: A function to call when window props are received, just before
|
|
the hot window is shown. The first parameter is the new windowProps.</p>
|
|
</div>
|
|
|
|
|
|
<h4 id="isMaximixed" class="function-name"><a name="isMaximixed" class="plugin-anchor" href="#isMaximixed"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
isMaximixed(<span class="args"></span>) <a href="#isMaximixed" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Is the current window maximized? </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="isFullScreen" class="function-name"><a name="isFullScreen" class="plugin-anchor" href="#isFullScreen"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
isFullScreen(<span class="args"></span>) <a href="#isFullScreen" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Is the current window in full screen mode? </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="setFullScreen" class="function-name"><a name="setFullScreen" class="plugin-anchor" href="#setFullScreen"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
setFullScreen(<span class="args"></span>) <a href="#setFullScreen" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Set the full screen state of the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="toggleFullScreen" class="function-name"><a name="toggleFullScreen" class="plugin-anchor" href="#toggleFullScreen"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
toggleFullScreen(<span class="args"></span>) <a href="#toggleFullScreen" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Toggle the full screen state of the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="beep" class="function-name"><a name="beep" class="plugin-anchor" href="#beep"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
beep(<span class="args"></span>) <a href="#beep" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Visually and audibly trigger a beep. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="confirm" class="function-name"><a name="confirm" class="plugin-anchor" href="#confirm"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
confirm(<span class="args"><span class="arg">options</span></span>) <a href="#confirm" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>A flexible way to open a dialog akin to an alert dialog.</p>
|
|
</div>
|
|
|
|
<p><strong>Parameters</strong></p>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="width:15%;">
|
|
<em>options</em>
|
|
</td>
|
|
<td class="markdown-from-sourecode">
|
|
|
|
An {Object} with the following keys:
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Returns</strong></p>
|
|
<p><table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode">Returns the chosen button index {Number} if the buttons option was an array.</td></tr>
|
|
</table></p>
|
|
<h4 id="openDevTools" class="function-name"><a name="openDevTools" class="plugin-anchor" href="#openDevTools"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
openDevTools(<span class="args"></span>) <a href="#openDevTools" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Open the dev tools for the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="toggleDevTools" class="function-name"><a name="toggleDevTools" class="plugin-anchor" href="#toggleDevTools"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
toggleDevTools(<span class="args"></span>) <a href="#toggleDevTools" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Toggle the visibility of the dev tools for the current window. </p>
|
|
</div>
|
|
|
|
|
|
<h4 id="executeJavaScriptInDevTools" class="function-name"><a name="executeJavaScriptInDevTools" class="plugin-anchor" href="#executeJavaScriptInDevTools"><i class="fa fa-link" aria-hidden="true"></i></a>
|
|
executeJavaScriptInDevTools(<span class="args"></span>) <a href="#executeJavaScriptInDevTools" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p>Execute code in dev tools. </p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="KeyCommandsRegion.html" class="navigation navigation-prev " aria-label="Previous page: KeyCommandsRegion">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="QueryResultSet.html" class="navigation navigation-next " aria-label="Next page: QueryResultSet">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"NylasEnvConstructor","level":"2.1.10","depth":2,"next":{"title":"QueryResultSet","level":"2.1.11","depth":2,"path":"classes/QueryResultSet.md","ref":"classes/QueryResultSet.md","articles":[]},"previous":{"title":"KeyCommandsRegion","level":"2.1.9","depth":2,"path":"classes/KeyCommandsRegion.md","ref":"classes/KeyCommandsRegion.md","articles":[]},"dir":"ltr"},"config":{"plugins":["search","lunr","-fontsettings","-sharing","anchors","github","editlink","favicon"],"root":"./docs_src","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/nylas/nylas-mail-docs/tree/master"},"github":{"url":"https://github.com/nylas/nylas-mail-docs"},"favicon":{"shortcut":"/img/favicon.png"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"anchors":{},"highlight":{},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Nylas Mail Plugin SDK","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"3.2.2"},"file":{"path":"classes/NylasEnvConstructor.md","mtime":"2017-01-30T10:28:19.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-01-30T10:28:53.038Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-editlink/plugin.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|