Skip to content

Commit

Permalink
Merge pull request #171 from webex/gh-pages-3.11.2
Browse files Browse the repository at this point in the history
3.11.2 Documentation
  • Loading branch information
rohits5-cisco authored May 7, 2024
2 parents 3abb3a4 + 3e8e527 commit ea4d269
Show file tree
Hide file tree
Showing 9 changed files with 244 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<div class="cover ">
<h1 class="cover"><span><span>create</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":sdk:SDK:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create.html"><span class="token function">create</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;targetUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;resource<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;event<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;filter<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;secret<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;handler<span class="token operator">: </span><a href="../../com.ciscowebex.androidsdk/-completion-handler/index.html">CompletionHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-webhook/index.html">Webhook</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Posts a webhook for the authenticated user.</p><h4 class="">Since</h4><p class="paragraph">0.1</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>name</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A user-friendly name for this webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span>target</span><wbr></wbr><span><span>Url</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The URL that receives POST requests for each event.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>resource</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The resource type for the webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>event</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The event type for the webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>filter</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The filter that defines the webhook scope.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>secret</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Secret use to generate payload signiture</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>handler</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A closure to be executed once the request has finished.</p></div></div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":sdk:SDK:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="create.html"><span class="token function">create</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;targetUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;resource<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;event<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;filter<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;secret<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;handler<span class="token operator">: </span><a href="../../com.ciscowebex.androidsdk/-completion-handler/index.html">CompletionHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-webhook/index.html">Webhook</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Posts a webhook for the authenticated user.</p><h4 class="">Since</h4><p class="paragraph">0.1</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>name</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A user-friendly name for this webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span>target</span><wbr></wbr><span><span>Url</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The URL that receives POST requests for each event.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>resource</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The resource type for the webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>event</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The event type for the webhook.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>filter</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The filter that defines the webhook scope.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>secret</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Secret use to generate payload signature</p></div></div></div></div></div><div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>handler</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A closure to be executed once the request has finished.</p></div></div></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
82 changes: 82 additions & 0 deletions -s-d-k/com.ciscowebex.androidsdk/-webex-auth-delegate/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>WebexAuthDelegate</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}</script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>SDK</span>
</a>
</div>
<div>
</div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="SDK::com.ciscowebex.androidsdk/WebexAuthDelegate///PointingToDeclaration//1234961455">
<div class="breadcrumbs"><a href="../../../index.html">SDK</a><span class="delimiter">/</span><a href="../index.html">com.ciscowebex.androidsdk</a><span class="delimiter">/</span><a href="index.html">WebexAuthDelegate</a></div>
<div class="cover ">
<h1 class="cover"><span>Webex</span><wbr></wbr><span>Auth</span><wbr></wbr><span><span>Delegate</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":sdk:SDK:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">WebexAuthDelegate</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">An interface for login related event callbacks.</p><h4 class="">Since</h4><p class="paragraph">3.11.2</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="2007602995%2FFunctions%2F1234961455" anchor-label="onReLoginRequired" id="2007602995%2FFunctions%2F1234961455" data-filterable-set=":sdk:SDK:dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":sdk:SDK:dokkaHtml/main" data-filterable-set=":sdk:SDK:dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="on-re-login-required.html"><span>on</span><wbr></wbr><span>Re</span><wbr></wbr><span>Login</span><wbr></wbr><span><span>Required</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2007602995%2FFunctions%2F1234961455"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":sdk:SDK:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="on-re-login-required.html"><span class="token function">onReLoginRequired</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">This will notify when user is logged out and re login is required</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>
Loading

0 comments on commit ea4d269

Please sign in to comment.