Files
2026-01-23 21:37:49 +00:00

262 lines
11 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UserAgent | @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.UserAgent.html">UserAgent</a>
</li>
</ul>
<h1>Interface UserAgent</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">UserAgent</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.UserAgent.html#browserName" class="tsd-kind-icon">browser<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.UserAgent.html#browserVersion" class="tsd-kind-icon">browser<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.UserAgent.html#deviceType" class="tsd-kind-icon">device<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.UserAgent.html#osName" class="tsd-kind-icon">os<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.UserAgent.html#osVersion" class="tsd-kind-icon">os<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.UserAgent.html#raw" class="tsd-kind-icon">raw</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="browserName" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> browser<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">browser<wbr>Name<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/fbbc742/src/datatypes.ts#L244">datatypes.ts:244</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>browser name (e.g. Chrome)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="browserVersion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> browser<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">browser<wbr>Version<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/fbbc742/src/datatypes.ts#L246">datatypes.ts:246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>browser version (e.g. 102)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="deviceType" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> device<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">device<wbr>Type<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/fbbc742/src/datatypes.ts#L248">datatypes.ts:248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>type of device (e.g. Desktop)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="osName" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> os<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">os<wbr>Name<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/fbbc742/src/datatypes.ts#L250">datatypes.ts:250</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>operating system name (e.g. MacOS)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="osVersion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> os<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">os<wbr>Version<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/fbbc742/src/datatypes.ts#L252">datatypes.ts:252</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>operating system version (e.g. 10.15.7)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="raw" class="tsd-anchor"></a>
<h3>raw</h3>
<div class="tsd-signature tsd-kind-icon">raw<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/fbbc742/src/datatypes.ts#L242">datatypes.ts:242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>raw User-Agent request header</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.UserAgent.html" class="tsd-kind-icon">User<wbr>Agent</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#browserName" class="tsd-kind-icon">browser<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#browserVersion" class="tsd-kind-icon">browser<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#deviceType" class="tsd-kind-icon">device<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#osName" class="tsd-kind-icon">os<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#osVersion" class="tsd-kind-icon">os<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.UserAgent.html#raw" class="tsd-kind-icon">raw</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>