urbanairship-react-native
Version:
Airship plugin for React Native apps.
308 lines • 14.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RegistrationEvent | 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_.registrationevent.html">RegistrationEvent</a>
</li>
</ul>
<h1>Interface RegistrationEvent</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>Event fired when a channel registration occurs.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">RegistrationEvent</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_.registrationevent.html#channelid" class="tsd-kind-icon">channel<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_urbanairship_.registrationevent.html#registrationtoken" class="tsd-kind-icon">registration<wbr>Token</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="channelid" class="tsd-anchor"></a>
<h3>channel<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">channel<wbr>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/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/UrbanAirship.ts#L617">urbanairship-react-native/js/UrbanAirship.ts:617</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The channel ID.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="registrationtoken" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> registration<wbr>Token</h3>
<div class="tsd-signature tsd-kind-icon">registration<wbr>Token<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></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#L624">urbanairship-react-native/js/UrbanAirship.ts:624</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The registration token. The registration token might be undefined
if registration is currently in progress, if the app is not setup properly
for remote notifications, if running on an iOS simulator, or if running on
an Android device that has an outdated or missing version of Google Play Services.</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>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.airshipconfig.html" class="tsd-kind-icon">Airship<wbr>Config</a>
</li>
<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>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_urbanairship_.registrationevent.html" class="tsd-kind-icon">Registration<wbr>Event</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.registrationevent.html#channelid" class="tsd-kind-icon">channel<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_urbanairship_.registrationevent.html#registrationtoken" class="tsd-kind-icon">registration<wbr>Token</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<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>