UNPKG

urbanairship-react-native

Version:
328 lines 15.3 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>NotificationOption | 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">&quot;UrbanAirship&quot;</a> </li> <li> <a href="../modules/_urbanairship_.ios.html">iOS</a> </li> <li> <a href="_urbanairship_.ios.notificationoption.html">NotificationOption</a> </li> </ul> <h1>Enumeration NotificationOption</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>Enum of notification options. iOS only.</p> </div> </div> </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>Enumeration members</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#alert" class="tsd-kind-icon">Alert</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#badge" class="tsd-kind-icon">Badge</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#carplay" class="tsd-kind-icon">Car<wbr>Play</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#criticalalert" class="tsd-kind-icon">Critical<wbr>Alert</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#providesappnotificationsettings" class="tsd-kind-icon">Provides<wbr>App<wbr>Notification<wbr>Settings</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#provisional" class="tsd-kind-icon">Provisional</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_urbanairship_.ios.notificationoption.html#sound" class="tsd-kind-icon">Sound</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Enumeration members</h2> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="alert" class="tsd-anchor"></a> <h3>Alert</h3> <div class="tsd-signature tsd-kind-icon">Alert<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;alert&quot;</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#L342">urbanairship-react-native/js/UrbanAirship.ts:342</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Alerts.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="badge" class="tsd-anchor"></a> <h3>Badge</h3> <div class="tsd-signature tsd-kind-icon">Badge<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;badge&quot;</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#L350">urbanairship-react-native/js/UrbanAirship.ts:350</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Badges.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="carplay" class="tsd-anchor"></a> <h3>Car<wbr>Play</h3> <div class="tsd-signature tsd-kind-icon">Car<wbr>Play<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;carPlay&quot;</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#L354">urbanairship-react-native/js/UrbanAirship.ts:354</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Car play.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="criticalalert" class="tsd-anchor"></a> <h3>Critical<wbr>Alert</h3> <div class="tsd-signature tsd-kind-icon">Critical<wbr>Alert<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;criticalAlert&quot;</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#L358">urbanairship-react-native/js/UrbanAirship.ts:358</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Critical Alert.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="providesappnotificationsettings" class="tsd-anchor"></a> <h3>Provides<wbr>App<wbr>Notification<wbr>Settings</h3> <div class="tsd-signature tsd-kind-icon">Provides<wbr>App<wbr>Notification<wbr>Settings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;providesAppNotificationSettings&quot;</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#L362">urbanairship-react-native/js/UrbanAirship.ts:362</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Provides app notification settings.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="provisional" class="tsd-anchor"></a> <h3>Provisional</h3> <div class="tsd-signature tsd-kind-icon">Provisional<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;provisional&quot;</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#L366">urbanairship-react-native/js/UrbanAirship.ts:366</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Provisional.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="sound" class="tsd-anchor"></a> <h3>Sound</h3> <div class="tsd-signature tsd-kind-icon">Sound<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;sound&quot;</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#L346">urbanairship-react-native/js/UrbanAirship.ts:346</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sounds.</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">&quot;<wbr>Attribute<wbr>Editor&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_customevent_.html">&quot;<wbr>Custom<wbr>Event&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_json_.html">&quot;<wbr>Json&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_messageview_.html">&quot;<wbr>Message<wbr>View&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_scopedsubscriptionlisteditor_.html">&quot;<wbr>Scoped<wbr>Subscription<wbr>List<wbr>Editor&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_subscriptionlisteditor_.html">&quot;<wbr>Subscription<wbr>List<wbr>Editor&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_subscriptionlists_.html">&quot;<wbr>Subscription<wbr>Lists&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_taggroupeditor_.html">&quot;<wbr>Tag<wbr>Group<wbr>Editor&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_uaeventemitter_.html">&quot;UAEvent<wbr>Emitter&quot;</a> </li> <li class="current tsd-kind-module"> <a href="../modules/_urbanairship_.html">&quot;<wbr>Urban<wbr>Airship&quot;</a> <ul> <li class="current 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-namespace"> <a href="_urbanairship_.ios.authorizednotificationsetting.html" class="tsd-kind-icon">Authorized<wbr>Notification<wbr>Setting</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-namespace"> <a href="_urbanairship_.ios.authorizednotificationstatus.html" class="tsd-kind-icon">Authorized<wbr>Notification<wbr>Status</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-namespace"> <a href="_urbanairship_.ios.foregroundpresentationoption.html" class="tsd-kind-icon">Foreground<wbr>Presentation<wbr>Option</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-enum tsd-parent-kind-namespace"> <a href="_urbanairship_.ios.notificationoption.html" class="tsd-kind-icon">Notification<wbr>Option</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#alert" class="tsd-kind-icon">Alert</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#badge" class="tsd-kind-icon">Badge</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#carplay" class="tsd-kind-icon">Car<wbr>Play</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#criticalalert" class="tsd-kind-icon">Critical<wbr>Alert</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#providesappnotificationsettings" class="tsd-kind-icon">Provides<wbr>App<wbr>Notification<wbr>Settings</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#provisional" class="tsd-kind-icon">Provisional</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_urbanairship_.ios.notificationoption.html#sound" class="tsd-kind-icon">Sound</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-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-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> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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>