urbanairship-react-native
Version:
Airship plugin for React Native apps.
600 lines • 35.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AirshipConfig | urbanairship-react-native</title>
<meta name="description" content="Documentation for urbanairship-react-native">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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">urbanairship-react-native</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_urbanairship_.html">"UrbanAirship"</a>
</li>
<li>
<a href="_urbanairship_.airshipconfig.html">AirshipConfig</a>
</li>
</ul>
<h1>Interface AirshipConfig</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Airship config</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AirshipConfig</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="_urbanairship_.airshipconfig.html#android" class="tsd-kind-icon">android</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#chat" class="tsd-kind-icon">chat</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#default" class="tsd-kind-icon">default</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#development" class="tsd-kind-icon">development</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#enabledfeatures" class="tsd-kind-icon">enabled<wbr>Features</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#inproduction" class="tsd-kind-icon">in<wbr>Production</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#initialconfigurl" class="tsd-kind-icon">initial<wbr>Config<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#ios" class="tsd-kind-icon">ios</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#ischannelcaptureenabled" class="tsd-kind-icon">is<wbr>Channel<wbr>Capture<wbr>Enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#ischannelcreationdelayenabled" class="tsd-kind-icon">is<wbr>Channel<wbr>Creation<wbr>Delay<wbr>Enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#production" class="tsd-kind-icon">production</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#requireinitialremoteconfigenabled" class="tsd-kind-icon">require<wbr>Initial<wbr>Remote<wbr>Config<wbr>Enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#site" class="tsd-kind-icon">site</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#suppressallowlisterror" class="tsd-kind-icon">suppress<wbr>Allow<wbr>List<wbr>Error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#urlallowlist" class="tsd-kind-icon">url<wbr>Allow<wbr>List</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#urlallowlistscopejavascriptinterface" class="tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Java<wbr>Script<wbr>Interface</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.airshipconfig.html#urlallowlistscopeopenurl" class="tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Open<wbr>Url</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="android" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> android</h3>
<div class="tsd-signature tsd-kind-icon">android<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>appStoreUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fcmFirebaseAppName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>notificationConfig<span class="tsd-signature-symbol">?: </span><a href="_urbanairship_.notificationconfigandroid.html" class="tsd-signature-type">NotificationConfigAndroid</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L302">urbanairship-react-native/js/UrbanAirship.ts:302</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Android config.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="chat" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> chat</h3>
<div class="tsd-signature tsd-kind-icon">chat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>webSocketUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L285">urbanairship-react-native/js/UrbanAirship.ts:285</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Chat config. Only needed with the chat module.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="default" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> default</h3>
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <a href="_urbanairship_.configenvironment.html" class="tsd-signature-type">ConfigEnvironment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L209">urbanairship-react-native/js/UrbanAirship.ts:209</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default environment.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="development" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> development</h3>
<div class="tsd-signature tsd-kind-icon">development<span class="tsd-signature-symbol">:</span> <a href="_urbanairship_.configenvironment.html" class="tsd-signature-type">ConfigEnvironment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L214">urbanairship-react-native/js/UrbanAirship.ts:214</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Development environment. Overrides default environment if inProduction is false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enabledfeatures" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled<wbr>Features</h3>
<div class="tsd-signature tsd-kind-icon">enabled<wbr>Features<span class="tsd-signature-symbol">:</span> <a href="../enums/_urbanairship_.feature.html" class="tsd-signature-type">Feature</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L280">urbanairship-react-native/js/UrbanAirship.ts:280</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enabled features. Defaults to all.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inproduction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr>Production</h3>
<div class="tsd-signature tsd-kind-icon">in<wbr>Production<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L230">urbanairship-react-native/js/UrbanAirship.ts:230</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Switches the environment from development or production. If the value is not
set, Airship will determine the value at runtime.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="initialconfigurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr>Config<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">initial<wbr>Config<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/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L268">urbanairship-react-native/js/UrbanAirship.ts:268</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initial config URL for custom Airship domains. The URL
should also be added to the urlAllowList.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ios" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ios</h3>
<div class="tsd-signature tsd-kind-icon">ios<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>itunesId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L292">urbanairship-react-native/js/UrbanAirship.ts:292</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>iOS config.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ischannelcaptureenabled" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Channel<wbr>Capture<wbr>Enabled</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Channel<wbr>Capture<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L251">urbanairship-react-native/js/UrbanAirship.ts:251</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables channel capture feature.
This config is enabled by default.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ischannelcreationdelayenabled" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Channel<wbr>Creation<wbr>Delay<wbr>Enabled</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Channel<wbr>Creation<wbr>Delay<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L262">urbanairship-react-native/js/UrbanAirship.ts:262</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables delayed channel creation.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="production" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> production</h3>
<div class="tsd-signature tsd-kind-icon">production<span class="tsd-signature-symbol">:</span> <a href="_urbanairship_.configenvironment.html" class="tsd-signature-type">ConfigEnvironment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L219">urbanairship-react-native/js/UrbanAirship.ts:219</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Production environment. Overrides default environment if inProduction is true.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="requireinitialremoteconfigenabled" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> require<wbr>Initial<wbr>Remote<wbr>Config<wbr>Enabled</h3>
<div class="tsd-signature tsd-kind-icon">require<wbr>Initial<wbr>Remote<wbr>Config<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L275">urbanairship-react-native/js/UrbanAirship.ts:275</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables/disables requiring initial remote config fetch before
creating a channel.</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd><p>This config is enabled by default.</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="site" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> site</h3>
<div class="tsd-signature tsd-kind-icon">site<span class="tsd-signature-symbol">:</span> <a href="../modules/_urbanairship_.html#site" class="tsd-signature-type">Site</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L224">urbanairship-react-native/js/UrbanAirship.ts:224</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Cloud site.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="suppressallowlisterror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> suppress<wbr>Allow<wbr>List<wbr>Error</h3>
<div class="tsd-signature tsd-kind-icon">suppress<wbr>Allow<wbr>List<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L257">urbanairship-react-native/js/UrbanAirship.ts:257</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether to suppress console error messages about missing allow list entries during takeOff.
This config is disabled by default.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="urlallowlist" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url<wbr>Allow<wbr>List</h3>
<div class="tsd-signature tsd-kind-icon">url<wbr>Allow<wbr>List<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L235">urbanairship-react-native/js/UrbanAirship.ts:235</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URL allow list.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="urlallowlistscopejavascriptinterface" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url<wbr>Allow<wbr>List<wbr>Scope<wbr>Java<wbr>Script<wbr>Interface</h3>
<div class="tsd-signature tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Java<wbr>Script<wbr>Interface<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L245">urbanairship-react-native/js/UrbanAirship.ts:245</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URL allow list for JS bridge injection.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="urlallowlistscopeopenurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url<wbr>Allow<wbr>List<wbr>Scope<wbr>Open<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Open<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L240">urbanairship-react-native/js/UrbanAirship.ts:240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URL allow list for open URL scope.</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_attributeeditor_.html">"<wbr>Attribute<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_customevent_.html">"<wbr>Custom<wbr>Event"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_json_.html">"<wbr>Json"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_messageview_.html">"<wbr>Message<wbr>View"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_scopedsubscriptionlisteditor_.html">"<wbr>Scoped<wbr>Subscription<wbr>List<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_subscriptionlisteditor_.html">"<wbr>Subscription<wbr>List<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_subscriptionlists_.html">"<wbr>Subscription<wbr>Lists"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_taggroupeditor_.html">"<wbr>Tag<wbr>Group<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_uaeventemitter_.html">"UAEvent<wbr>Emitter"</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_urbanairship_.html">"<wbr>Urban<wbr>Airship"</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_urbanairship_.ios.html">iOS</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/_urbanairship_.eventtype.html" class="tsd-kind-icon">Event<wbr>Type</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/_urbanairship_.feature.html" class="tsd-kind-icon">Feature</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/_urbanairship_.subscriptionscope.html" class="tsd-kind-icon">Subscription<wbr>Scope</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_urbanairship_.subscription.html" class="tsd-kind-icon">Subscription</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_urbanairship_.urbanairship.html" class="tsd-kind-icon">Urban<wbr>Airship</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.airshipconfig.html" class="tsd-kind-icon">Airship<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#android" class="tsd-kind-icon">android</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#chat" class="tsd-kind-icon">chat</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#default" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#development" class="tsd-kind-icon">development</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#enabledfeatures" class="tsd-kind-icon">enabled<wbr>Features</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#inproduction" class="tsd-kind-icon">in<wbr>Production</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#initialconfigurl" class="tsd-kind-icon">initial<wbr>Config<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#ios" class="tsd-kind-icon">ios</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#ischannelcaptureenabled" class="tsd-kind-icon">is<wbr>Channel<wbr>Capture<wbr>Enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#ischannelcreationdelayenabled" class="tsd-kind-icon">is<wbr>Channel<wbr>Creation<wbr>Delay<wbr>Enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#production" class="tsd-kind-icon">production</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#requireinitialremoteconfigenabled" class="tsd-kind-icon">require<wbr>Initial<wbr>Remote<wbr>Config<wbr>Enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#site" class="tsd-kind-icon">site</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#suppressallowlisterror" class="tsd-kind-icon">suppress<wbr>Allow<wbr>List<wbr>Error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#urlallowlist" class="tsd-kind-icon">url<wbr>Allow<wbr>List</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#urlallowlistscopejavascriptinterface" class="tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Java<wbr>Script<wbr>Interface</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.airshipconfig.html#urlallowlistscopeopenurl" class="tsd-kind-icon">url<wbr>Allow<wbr>List<wbr>Scope<wbr>Open<wbr>Url</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.configenvironment.html" class="tsd-kind-icon">Config<wbr>Environment</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.deeplinkevent.html" class="tsd-kind-icon">Deep<wbr>Link<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.inboxmessage.html" class="tsd-kind-icon">Inbox<wbr>Message</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.inboxupdatedevent.html" class="tsd-kind-icon">Inbox<wbr>Updated<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.notificationconfigandroid.html" class="tsd-kind-icon">Notification<wbr>Config<wbr>Android</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.notificationoptinstatusevent.html" class="tsd-kind-icon">Notification<wbr>Opt<wbr>InStatus<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.notificationresponseevent.html" class="tsd-kind-icon">Notification<wbr>Response<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.notificationstatus.html" class="tsd-kind-icon">Notification<wbr>Status</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.openpreferencecenterevent.html" class="tsd-kind-icon">Open<wbr>Preference<wbr>Center<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.pushreceivedevent.html" class="tsd-kind-icon">Push<wbr>Received<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.registrationevent.html" class="tsd-kind-icon">Registration<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.showinboxevent.html" class="tsd-kind-icon">Show<wbr>Inbox<wbr>Event</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#authorizednotificationsettingsios" class="tsd-kind-icon">Authorized<wbr>Notification<wbr>SettingsIOS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#foregroundnotificationoptionsios" class="tsd-kind-icon">Foreground<wbr>Notification<wbr>OptionsIOS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#loglevel" class="tsd-kind-icon">Log<wbr>Level</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#notificationoptionsios" class="tsd-kind-icon">Notification<wbr>OptionsIOS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#notificationoptionsmapios" class="tsd-kind-icon">Notification<wbr>Options<wbr>MapIOS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#site" class="tsd-kind-icon">Site</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_urbanairship_.html#iosauthorizednotificationsettingsmap" class="tsd-kind-icon">iOSAuthorized<wbr>Notification<wbr>Settings<wbr>Map</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_urbanairship_.html#convertfeatureenum" class="tsd-kind-icon">convert<wbr>Feature<wbr>Enum</a>
</li>
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<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>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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>