ngrok/ngrok-api-typescript
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-typescript.git synced 2026-05-17 16:50:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2fc3a0243468e15fba5c4d1d99f5c195166ecb1d
ngrok-api-typescript/docs/interfaces/datatypes.ApplicationSession.html
T
ngrok release bot 72d8adcda3 Update generated files
2025-05-27 22:08:32 +00:00

357 lines
16 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ApplicationSession | @ngrok/ngrok-api</title>
<meta name="description" content="Documentation for @ngrok/ngrok-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@ngrok/ngrok-api</a>
</li>
<li>
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li>
<a href="datatypes.ApplicationSession.html">ApplicationSession</a>
</li>
</ul>
<h1>Interface ApplicationSession</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ApplicationSession</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#applicationUser" class="tsd-kind-icon">application<wbr>User</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#browserSession" class="tsd-kind-icon">browser<wbr>Session</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#edge" class="tsd-kind-icon">edge</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#endpoint" class="tsd-kind-icon">endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#expiresAt" class="tsd-kind-icon">expires<wbr>At</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#lastActive" class="tsd-kind-icon">last<wbr>Active</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#route" class="tsd-kind-icon">route</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#uri" class="tsd-kind-icon">uri</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="applicationUser" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> application<wbr>User</h3>
<div class="tsd-signature tsd-kind-icon">application<wbr>User<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L191">datatypes.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>application user this session is associated with</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="browserSession" class="tsd-anchor"></a>
<h3>browser<wbr>Session</h3>
<div class="tsd-signature tsd-kind-icon">browser<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.BrowserSession.html" class="tsd-signature-type" data-tsd-kind="Interface">BrowserSession</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L189">datatypes.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>browser session details of the application session</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="createdAt" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> created<wbr>At</h3>
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L193">datatypes.ts:193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>timestamp when the user was created in RFC 3339 format</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="edge" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> edge</h3>
<div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L201">datatypes.ts:201</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>edge this session is associated with, null if the endpoint is agent-initiated</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="endpoint" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> endpoint</h3>
<div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L199">datatypes.ts:199</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>ephemeral endpoint this session is associated with</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="expiresAt" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> expires<wbr>At</h3>
<div class="tsd-signature tsd-kind-icon">expires<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L197">datatypes.ts:197</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>timestamp when session expires in RFC 3339 format</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L183">datatypes.ts:183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>unique application session resource identifier</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="lastActive" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr>Active</h3>
<div class="tsd-signature tsd-kind-icon">last<wbr>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L195">datatypes.ts:195</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>timestamp when the user was last active in RFC 3339 format</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="publicUrl" class="tsd-anchor"></a>
<h3>public<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L187">datatypes.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URL of the hostport served by this endpoint</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="route" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> route</h3>
<div class="tsd-signature tsd-kind-icon">route<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L203">datatypes.ts:203</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>route this session is associated with, null if the endpoint is agent-initiated</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="uri" class="tsd-anchor"></a>
<h3>uri</h3>
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/19686b4/src/datatypes.ts#L185">datatypes.ts:185</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URI of the application session API resource</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/client.html">client</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/services.html">services</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="datatypes.ApplicationSession.html" class="tsd-kind-icon">Application<wbr>Session</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#applicationUser" class="tsd-kind-icon">application<wbr>User</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#browserSession" class="tsd-kind-icon">browser<wbr>Session</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#edge" class="tsd-kind-icon">edge</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#endpoint" class="tsd-kind-icon">endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#expiresAt" class="tsd-kind-icon">expires<wbr>At</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#lastActive" class="tsd-kind-icon">last<wbr>Active</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#route" class="tsd-kind-icon">route</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.ApplicationSession.html#uri" class="tsd-kind-icon">uri</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink