[docs] update for 2.4b2

hbang · Mar 18, 2018 · f4a68be · f4a68be
1 parent ac3573a
commit f4a68be
Show file tree

Hide file tree

Showing 21 changed files with 253 additions and 141 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -157,7 +157,7 @@ <h4>Declaration</h4>
                       <div class="abstract">
                         <p>HBTSProvider is the class used to represent a provider. You should subclass HBTSProvider
 in your provider bundle, and then set it as the principal class in the Info.plist. A provider
-class is required even if it doesn&rsquo;t implement any methods on its own.</p>
+class is required even if it doesn’t implement any methods on its own.</p>
 
                         <a href="Classes/HBTSProvider.html" class="slightly-smaller">See more</a>
                       </div>
@@ -223,7 +223,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-16)</p>
+      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-18)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/HBTSNotification.html b/docs/Classes/HBTSNotification.html
@@ -211,8 +211,9 @@ <h4>Return Value</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Initialises and returns an HBTSNotification with the provided serialized notification dictionary.
-Used by TypeStatus Plus when internally deserializing a notification to be displayed.</p>
+                        <p>Initialises and returns an HBTSNotification with the provided serialized notification dictionary.</p>
+
+<p>Used by TypeStatus when internally deserializing a notification to be displayed.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     dictionaryRepresentation
@@ -224,12 +225,13 @@ <h4>Return Value</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span></code></pre>
+                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:</span>
+    <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span></code></pre>
 
                         </div>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">dictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyHashable</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">])</span></code></pre>
+                          <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">dictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">])</span></code></pre>
 
                         </div>
                       </div>
@@ -272,8 +274,9 @@ <h4>Return Value</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Serializes the notification into a dictionary. Used by TypeStatus Plus internally to prepare the
-notification to be sent to other processes.</p>
+                        <p>Serializes the notification into a dictionary.</p>
+
+<p>Used by TypeStatus Plus internally to prepare the notification to be sent to other processes.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     initWithDictionary:
@@ -285,12 +288,12 @@ <h4>Return Value</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span> <span class="o">*</span><span class="p">)</span><span class="n">dictionaryRepresentation</span><span class="p">;</span></code></pre>
+                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="n">dictionaryRepresentation</span><span class="p">;</span></code></pre>
 
                         </div>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">dictionaryRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">AnyHashable</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">dictionaryRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]</span></code></pre>
 
                         </div>
                       </div>
@@ -311,7 +314,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The bundle identifier of the app this notification originates from, or nil to have this property
-automatically determined by TypeStatus based on the provider&rsquo;s matching app identifier.</p>
+automatically determined by TypeStatus based on the provider’s matching app identifier.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     -[HBTSProvider appIdentifier]
@@ -415,7 +418,9 @@ <h4>Declaration</h4>
                       <div class="abstract">
                         <p>The date the notification originated. Displayed in Notification Center bulletins.</p>
 
-<p>The default value is the timestamp that the HBTSNotification was initialised.</p>
+<p>The default value is the timestamp of when the HBTSNotification was initialised. Notifications
+with a date more than a minute in the past will be ignored to avoid confusing the user, and to
+prevent many old notifications appearing at once when the device regains an internet connection.</p>
 
                       </div>
                       <div class="declaration">
@@ -509,7 +514,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-16)</p>
+      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-18)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/HBTSProvider.html b/docs/Classes/HBTSProvider.html
@@ -104,7 +104,7 @@ <h1>HBTSProvider</h1>
               </div>
             <p>HBTSProvider is the class used to represent a provider. You should subclass HBTSProvider
 in your provider bundle, and then set it as the principal class in the Info.plist. A provider
-class is required even if it doesn&rsquo;t implement any methods on its own.</p>
+class is required even if it doesn’t implement any methods on its own.</p>
 
           </div>
         </section>
@@ -113,44 +113,6 @@ <h1>HBTSProvider</h1>
           <div class="section-content">
             <div class="task-group">
               <ul class="item-container">
-                <li class="item">
-                  <div>
-                    <code>
-                    <a name="/c:objc(cs)HBTSProvider(py)name"></a>
-                    <a name="//apple_ref/objc/Property/name" class="dashAnchor"></a>
-                    <a class="token" href="#/c:objc(cs)HBTSProvider(py)name">name</a>
-                    </code>
-                  </div>
-                  <div class="height-container">
-                    <div class="pointer-container"></div>
-                    <section class="section">
-                      <div class="pointer"></div>
-                      <div class="abstract">
-                        <p>The name of the provider, to display in the TypeStatus Plus settings. This typically does not
-need to be set, and will be populated with the app name corresponding to appIdentifier.</p>
-<div class="aside aside-see">
-    <p class="aside-title">See</p>
-    appIdentifier
-
-</div>
-
-                      </div>
-                      <div class="declaration">
-                        <h4>Declaration</h4>
-                        <div class="language">
-                          <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">retain</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre>
-
-                        </div>
-                        <div class="language">
-                          <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
-
-                        </div>
-                      </div>
-                    </section>
-                  </div>
-                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -166,7 +128,7 @@ <h4>Declaration</h4>
                       <div class="abstract">
                         <p>The bundle identifier of the app corresponding to this provider. This typically does not need to
 be set, and will be populated by the <code>HBTSApplicationBundleIdentifier</code> value provided in the
-provider&rsquo;s Info.plist.</p>
+provider’s Info.plist.</p>
 
                       </div>
                       <div class="declaration">
@@ -291,10 +253,10 @@ <h4>Declaration</h4>
                       <div class="abstract">
                         <p>Indicates whether the user has enabled the provider.</p>
 
-<p>If TypeStatus Plus is disabled by the user, this property is set to <code>NO</code>. If a custom preference
-list controller is used, this property is set to <code>YES</code> and you are expected to handle enabled
-state separately from TypeStatus Plus. Otherwise, this property is the enabled state of this
-provider as configured by the user.</p>
+<p>If TypeStatus is disabled by the user, this property is set to <code>NO</code>. If a custom preference list
+controller is used, this property is set to <code>YES</code> and you are expected to handle enabled state
+separately from TypeStatus. Otherwise, this property is the enabled state of this provider as
+configured by the user.</p>
 
                       </div>
                       <div class="declaration">
@@ -415,7 +377,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-16)</p>
+      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-18)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/HBTSProviderController.html b/docs/Classes/HBTSProviderController.html
@@ -177,7 +177,8 @@ <h4>Return Value</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">retain</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">providers</span><span class="p">;</span></code></pre>
+                          <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">retain</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
+    <span class="n">NSSet</span><span class="o">&lt;</span><span class="n"><a href="../Classes/HBTSProvider.html">HBTSProvider</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">providers</span><span class="p">;</span></code></pre>
 
                         </div>
                         <div class="language">
@@ -214,13 +215,13 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Objective-C</p>
-                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/HBTSProvider.html">HBTSProvider</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">providerForAppIdentifier</span><span class="p">:</span>
+                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/HBTSProvider.html">HBTSProvider</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">providerForAppIdentifier</span><span class="p">:</span>
     <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appIdentifier</span><span class="p">;</span></code></pre>
 
                         </div>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">provider</span><span class="p">(</span><span class="n">forAppIdentifier</span> <span class="nv">appIdentifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/HBTSProvider.html">HBTSProvider</a></span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">provider</span><span class="p">(</span><span class="n">forAppIdentifier</span> <span class="nv">appIdentifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/HBTSProvider.html">HBTSProvider</a></span><span class="p">?</span></code></pre>
 
                         </div>
                       </div>
@@ -245,7 +246,7 @@ <h4>Parameters</h4>
                       </div>
                       <div>
                         <h4>Return Value</h4>
-                        <p>The HBTSProvider corresponding to the provider, or nil if it doesn&rsquo;t exist or the
+                        <p>The HBTSProvider corresponding to the provider, or nil if it doesn’t exist or the
 bundle is not loaded in this process.</p>
                       </div>
                     </section>
@@ -278,7 +279,7 @@ <h4>Declaration</h4>
                         </div>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">doesApplicationIdentifierRequireBackgrounding</span><span class="p">(</span><span class="n">_</span> <span class="nv">bundleIdentifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">doesApplicationRequireBackgrounding</span><span class="p">(</span><span class="nv">bundleIdentifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
 
                         </div>
                       </div>
@@ -316,7 +317,7 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-16)</p>
+      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-18)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Constants.html b/docs/Constants.html
@@ -180,7 +180,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-16)</p>
+      <p>&copy; 2018 <a class="link" href="https://hbang.github.io/" target="_blank" rel="external">HASHBANG Productions</a>. All rights reserved. (Last updated: 2018-03-18)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>