Release OidcClient.Wpf and OidcClient.iOS (#175)

auth0 · Jan 7, 2021 · 26883b2 · 26883b2
1 parent abe9a63
commit 26883b2
Show file tree

Hide file tree

Showing 36 changed files with 1,059 additions and 396 deletions.
diff --git a/docs-source/api/.manifest b/docs-source/api/.manifest
@@ -13,7 +13,11 @@
   "Auth0.OidcClient.AndroidBrowserBase.IsNewTask": "Auth0.OidcClient.AndroidBrowserBase.yml",
   "Auth0.OidcClient.AndroidBrowserBase.OpenBrowser(Android.Net.Uri,Android.Content.Context)": "Auth0.OidcClient.AndroidBrowserBase.yml",
   "Auth0.OidcClient.ASWebAuthenticationSessionBrowser": "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.yml",
+  "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.#ctor(Auth0.OidcClient.ASWebAuthenticationSessionOptions)": "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.yml",
   "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.Launch(BrowserOptions,System.Threading.CancellationToken)": "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.yml",
+  "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.SessionOptions": "Auth0.OidcClient.ASWebAuthenticationSessionBrowser.yml",
+  "Auth0.OidcClient.ASWebAuthenticationSessionOptions": "Auth0.OidcClient.ASWebAuthenticationSessionOptions.yml",
+  "Auth0.OidcClient.ASWebAuthenticationSessionOptions.PrefersEphemeralWebBrowserSession": "Auth0.OidcClient.ASWebAuthenticationSessionOptions.yml",
   "Auth0.OidcClient.Auth0Client": "Auth0.OidcClient.Auth0Client.yml",
   "Auth0.OidcClient.Auth0Client.#ctor(Auth0ClientOptions)": "Auth0.OidcClient.Auth0Client.yml",
   "Auth0.OidcClient.Auth0ClientActivity": "Auth0.OidcClient.Auth0ClientActivity.yml",
@@ -27,11 +31,6 @@
   "Auth0.OidcClient.IOSBrowserBase": "Auth0.OidcClient.IOSBrowserBase.yml",
   "Auth0.OidcClient.IOSBrowserBase.InvokeAsync(BrowserOptions,System.Threading.CancellationToken)": "Auth0.OidcClient.IOSBrowserBase.yml",
   "Auth0.OidcClient.IOSBrowserBase.Launch(BrowserOptions,System.Threading.CancellationToken)": "Auth0.OidcClient.IOSBrowserBase.yml",
-  "Auth0.OidcClient.Resource": "Auth0.OidcClient.Resource.yml",
-  "Auth0.OidcClient.Resource.Attribute": "Auth0.OidcClient.Resource.Attribute.yml",
-  "Auth0.OidcClient.Resource.String": "Auth0.OidcClient.Resource.String.yml",
-  "Auth0.OidcClient.Resource.String.ApplicationName": "Auth0.OidcClient.Resource.String.yml",
-  "Auth0.OidcClient.Resource.String.Hello": "Auth0.OidcClient.Resource.String.yml",
   "Auth0.OidcClient.SFAuthenticationSessionBrowser": "Auth0.OidcClient.SFAuthenticationSessionBrowser.yml",
   "Auth0.OidcClient.SFAuthenticationSessionBrowser.Launch(BrowserOptions,System.Threading.CancellationToken)": "Auth0.OidcClient.SFAuthenticationSessionBrowser.yml",
   "Auth0.OidcClient.SFSafariViewControllerBrowser": "Auth0.OidcClient.SFSafariViewControllerBrowser.yml",

diff --git a/docs-source/docfx.json b/docs-source/docfx.json
@@ -14,7 +14,8 @@
           "cwd": "../src"
         }
       ],
-      "dest": "api"
+      "dest": "api",
+      "filter": "filter.yml"
     }
   ],
   "build": {

diff --git a/docs-source/filter.yml b/docs-source/filter.yml
@@ -0,0 +1,3 @@
+apiRules:
+  - exclude:
+      uidRegex: "^Auth0.OidcClient.Resource"
diff --git a/docs/api/Auth0.OidcClient.ASWebAuthenticationSessionBrowser.html b/docs/api/Auth0.OidcClient.ASWebAuthenticationSessionBrowser.html
@@ -94,14 +94,98 @@ <h5 id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser_syntax">Syntax</h5>
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class ASWebAuthenticationSessionBrowser : IOSBrowserBase</code></pre>
   </div>
+  <h3 id="constructors">Constructors
+  </h3>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser__ctor_Auth0_OidcClient_ASWebAuthenticationSessionOptions_.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser.%23ctor(Auth0.OidcClient.ASWebAuthenticationSessionOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L41">View Source</a>
+  </span>
+  <a id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser__ctor_" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.#ctor*"></a>
+  <h4 id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser__ctor_Auth0_OidcClient_ASWebAuthenticationSessionOptions_" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.#ctor(Auth0.OidcClient.ASWebAuthenticationSessionOptions)">ASWebAuthenticationSessionBrowser(ASWebAuthenticationSessionOptions)</h4>
+  <div class="markdown level1 summary"><p>Creates a new instance of the ASWebAuthenticationSession Browser.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public ASWebAuthenticationSessionBrowser(ASWebAuthenticationSessionOptions sessionOptions = null)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="Auth0.OidcClient.ASWebAuthenticationSessionOptions.html">ASWebAuthenticationSessionOptions</a></td>
+        <td><span class="parametername">sessionOptions</span></td>
+        <td><p>The <a class="xref" href="Auth0.OidcClient.ASWebAuthenticationSessionOptions.html">ASWebAuthenticationSessionOptions</a> specifying the configuration for the ASWebAuthenticationSession.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser__ctor_Auth0_OidcClient_ASWebAuthenticationSessionOptions__examples">Examples</h5>
+  <p>If any custom browser configuration is needed (e.g. using <a class="xref" href="Auth0.OidcClient.ASWebAuthenticationSessionOptions.html#Auth0_OidcClient_ASWebAuthenticationSessionOptions_PrefersEphemeralWebBrowserSession">PrefersEphemeralWebBrowserSession</a>), 
+a new browser instance should be instantiated and passed to <see cref="!:Auth0ClientOptions.Browser"></see>.</p>
+<pre><code>var client = new Auth0Client(new Auth0ClientOptions
+{
+  Domain = &quot;YOUR_AUTH0_DOMAIN&quot;,
+  ClientId = &quot;YOUR_AUTH0_CLIENT_ID&quot;,
+  Browser = new ASWebAuthenticationSessionBrowser(
+    new ASWebAuthenticationSessionOptions
+    {
+      PrefersEphemeralWebBrowserSession = true
+    }
+  )
+});</code></pre>
+
+  <h3 id="properties">Properties
+  </h3>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser_SessionOptions.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser.SessionOptions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L18">View Source</a>
+  </span>
+  <a id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser_SessionOptions_" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.SessionOptions*"></a>
+  <h4 id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser_SessionOptions" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.SessionOptions">SessionOptions</h4>
+  <div class="markdown level1 summary"><p>Configuration for the ASWebAuthenticationSession.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public ASWebAuthenticationSessionOptions SessionOptions { get; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="Auth0.OidcClient.ASWebAuthenticationSessionOptions.html">ASWebAuthenticationSessionOptions</a></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="methods">Methods
   </h3>
   <span class="small pull-right mobile-hide">
     <span class="divider">|</span>
-    <a href="https://github.com//auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser_Launch_BrowserOptions_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser.Launch(BrowserOptions%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+    <a href="https://github.com/auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser_Launch_BrowserOptions_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser.Launch(BrowserOptions%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com//auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L16">View Source</a>
+    <a href="https://github.com/auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L47">View Source</a>
   </span>
   <a id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser_Launch_" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.Launch*"></a>
   <h4 id="Auth0_OidcClient_ASWebAuthenticationSessionBrowser_Launch_BrowserOptions_System_Threading_CancellationToken_" data-uid="Auth0.OidcClient.ASWebAuthenticationSessionBrowser.Launch(BrowserOptions,System.Threading.CancellationToken)">Launch(BrowserOptions, CancellationToken)</h4>
@@ -163,10 +247,10 @@ <h5 class="overrides">Overrides</h5>
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com//auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/auth0/auth0-oidc-client-net/new/master/apiSpec/new?filename=Auth0_OidcClient_ASWebAuthenticationSessionBrowser.md&amp;value=---%0Auid%3A%20Auth0.OidcClient.ASWebAuthenticationSessionBrowser%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com//auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L13" class="contribution-link">View Source</a>
+                    <a href="https://github.com/auth0/auth0-oidc-client-net/blob/master/src/Auth0.OidcClient.iOS/ASWebAuthenticationSessionBrowser.cs/#L13" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>