Added distribution and API documentation for v0.0.28 release

linagora · May 16, 2018 · 527c2c3 · 527c2c3
1 parent 54502fb
commit 527c2c3
Show file tree

Hide file tree

Showing 92 changed files with 49,112 additions and 0 deletions.
diff --git a/dist/jmap-client.js b/dist/jmap-client.js
diff --git a/dist/jmap-client.min.js b/dist/jmap-client.min.js
diff --git a/doc/api/API.js.html b/doc/api/API.js.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: API.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: API.js</h1>
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>'use strict';
+
+/**
+ * The _API_ module is the entry point of the library.&lt;br />
+ * It exports a single {@link Object} that is exposed as, either:
+ * * A global `jmap` variable when jmap-client included in a web page through a `script` tag
+ * * A NodeJS module when jmap-client is `require`'d in a NodeJS application
+ *
+ * When extending the library with new models, utility classes, etc. don't forget to update this module
+ * so that your new code gets exposed in the public API.&lt;br />
+ * &lt;br />
+ * The exported object has the following properties:
+ *
+ * @property Client {Client} The {@link Client} class
+ * @property Utils {Utils} The {@link Utils} class
+ * @property JSONBuilder {JSONBuilder} The {@link JSONBuilder} class helping to serialize model to json
+ * @property PromiseProvider {PromiseProvider} The {@link PromiseProvider} class
+ * @property ES6PromiseProvider { ES6PromiseProvider} The {@link  ES6PromiseProvider} class
+ * @property QPromiseProvider { QPromiseProvider} The {@link  QPromiseProvider} class
+ * @property Transport { Transport} The {@link  Transport} class
+ * @property JQueryTransport { JQueryTransport} The {@link  JQueryTransport} class
+ * @property RequestTransport { RequestTransport} The {@link  RequestTransport} class
+ * @property Model { Model} The {@link  Model} class
+ * @property Account { Account} The {@link  Account} class
+ * @property EMailer { EMailer} The {@link  EMailer} class
+ * @property Mailbox { Mailbox} The {@link  Mailbox} class
+ * @property MessageList { MessageList} The {@link  MessageList} class
+ * @property Message { Message} The {@link  Message} class
+ * @property OutboundMessage {OutboundMessage} The {@link OutboundMessage} class
+ * @property CreateMessageAck {CreateMessageAck} The {@link CreateMessageAck} class
+ * @property Thread { Thread} The {@link  Thread} class
+ * @property MailboxRole {MailboxRole} The {@link MailboxRole} class
+ * @property SetResponse {SetResponse} The {@link SetResponse} class
+ * @property AuthAccess {AuthAccess} The {@link AuthAccess} class
+ * @property AuthContinuation {AuthContinuation} The {@link AuthContinuation} class
+ * @property Constants {Constants} The {@link module:Constants|Constants} object
+ * @property Attachment {Attachment} The {@link Attachment} class
+ * @property Capabilities {Capabilities} The {@link Capabilities} class
+ * @property MailCapabilities {MailCapabilities} The {@link MailCapabilities} class
+ * @property ServerCapabilities {ServerCapabilities} The {@link ServerCapabilities} class
+ * @property VacationResponse {VacationResponse} The {@link VacationResponse} class
+ * @property TransportError {TransportError} The {@link TransportError} class
+ * @property JmapError {JmapError} The {@link JmapError} class
+ *
+ * @module API
+ */
+export default {
+  Client: require('./client/Client'),
+  Utils: require('./utils/Utils'),
+  JSONBuilder: require('./utils/JSONBuilder'),
+  PromiseProvider: require('./promises/PromiseProvider'),
+  ES6PromiseProvider: require('./promises/ES6PromiseProvider'),
+  QPromiseProvider: require('./promises/QPromiseProvider'),
+  Transport: require('./transport/Transport'),
+  JQueryTransport: require('./transport/JQueryTransport'),
+  RequestTransport: require('./transport/RequestTransport'),
+  Model: require('./models/Model'),
+  Account: require('./models/Account'),
+  EMailer: require('./models/EMailer'),
+  Mailbox: require('./models/Mailbox'),
+  MessageList: require('./models/MessageList'),
+  Message: require('./models/Message'),
+  OutboundMessage: require('./models/OutboundMessage'),
+  CreateMessageAck: require('./models/CreateMessageAck'),
+  Thread: require('./models/Thread'),
+  MailboxRole: require('./models/MailboxRole'),
+  SetResponse: require('./models/SetResponse'),
+  AuthAccess: require('./models/AuthAccess'),
+  AuthContinuation: require('./models/AuthContinuation'),
+  AuthMethod: require('./models/AuthMethod'),
+  Constants: require('./utils/Constants'),
+  Attachment: require('./models/Attachment'),
+  Capabilities: require('./models/Capabilities'),
+  MailCapabilities: require('./models/MailCapabilities'),
+  ServerCapabilities: require('./models/ServerCapabilities'),
+  VacationResponse: require('./models/VacationResponse'),
+  TransportError: require('./errors/TransportError'),
+  JmapError: require('./errors/JmapError')
+};
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-API.html">API</a></li><li><a href="module-Constants.html">Constants</a></li></ul><h3>Classes</h3><ul><li><a href="Account.html">Account</a></li><li><a href="Attachment.html">Attachment</a></li><li><a href="AuthAccess.html">AuthAccess</a></li><li><a href="AuthContinuation.html">AuthContinuation</a></li><li><a href="AuthMethod.html">AuthMethod</a></li><li><a href="Capabilities.html">Capabilities</a></li><li><a href="Client.html">Client</a></li><li><a href="CreateMessageAck.html">CreateMessageAck</a></li><li><a href="EMailer.html">EMailer</a></li><li><a href="ES6PromiseProvider.html">ES6PromiseProvider</a></li><li><a href="JmapError.html">JmapError</a></li><li><a href="JQueryTransport.html">JQueryTransport</a></li><li><a href="JSONBuilder.html">JSONBuilder</a></li><li><a href="Mailbox.html">Mailbox</a></li><li><a href="MailboxRole.html">MailboxRole</a></li><li><a href="MailCapabilities.html">MailCapabilities</a></li><li><a href="Message.html">Message</a></li><li><a href="MessageList.html">MessageList</a></li><li><a href="Model.html">Model</a></li><li><a href="OutboundMessage.html">OutboundMessage</a></li><li><a href="PromiseProvider.html">PromiseProvider</a></li><li><a href="QPromiseProvider.html">QPromiseProvider</a></li><li><a href="RequestTransport.html">RequestTransport</a></li><li><a href="ServerCapabilities.html">ServerCapabilities</a></li><li><a href="SetResponse.html">SetResponse</a></li><li><a href="Thread.html">Thread</a></li><li><a href="Transport.html">Transport</a></li><li><a href="TransportError.html">TransportError</a></li><li><a href="Utils.html">Utils</a></li><li><a href="VacationResponse.html">VacationResponse</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>