mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Website Deployment Script
d6c8c31cb1
Deploy website version based on aa6bca5d8b7a59a46c8e4e5a6803f43206c13b65
460 lines
70 KiB
HTML
460 lines
70 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PushNotificationIOS · React Native</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<div class="banner-crna-ejected">"/><meta name="docsearch:version" content="0.57"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="PushNotificationIOS · React Native"/><meta property="og:type" content="website"/><meta property="og:url" content="https://reactnative.dev/"/><meta property="og:description" content="<div class="banner-crna-ejected">"/><meta property="og:image" content="https://reactnative.dev/img/logo-og.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://reactnative.dev/img/logo-og.png"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://reactnative.dev/blog/atom.xml" title="React Native Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://reactnative.dev/blog/feed.xml" title="React Native Blog RSS Feed"/><script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-41298772-2', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/focus-visible@5.0.2/dist/focus-visible.min.js"></script><script type="text/javascript" src="https://snack.expo.io/embed.js"></script><script type="text/javascript" src="https://platform.twitter.com/widgets.js"></script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="/js/codeblocks.js"></script><script type="text/javascript" src="/js/tabs.js"></script><script type="text/javascript" src="/js/docs-rating.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
addBackToTop(
|
||
{"zIndex":100}
|
||
)
|
||
});
|
||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/header_logo.svg" alt="React Native"/><h2 class="headerTitleWithLogo">React Native</h2></a><a href="/versions"><h3>0.57</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/0.57/getting-started" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/0.57/components-and-apis" target="_self">Components</a></li><li class="siteNavGroupActive"><a href="/docs/0.57/accessibilityinfo" target="_self">API</a></li><li class=""><a href="/help" target="_self">Community</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li><li class=""><a href="https://github.com/facebook/react-native" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>APIs</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">The Basics<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/getting-started">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/tutorial">Learn the Basics</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/props">Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/state">State</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/style">Style</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/height-and-width">Height and Width</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/flexbox">Layout with Flexbox</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/handling-text-input">Handling Text Input</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/handling-touches">Handling Touches</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/using-a-scrollview">Using a ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/using-a-listview">Using List Views</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/network">Networking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/more-resources">More Resources</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/components-and-apis">Components and APIs</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/platform-specific-code">Platform Specific Code</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/navigation">Navigating Between Screens</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/images">Images</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/animations">Animations</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/accessibility">Accessibility</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/improvingux">Improving User Experience</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/timers">Timers</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/debugging">Debugging</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/performance">Performance</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/gesture-responder-system">Gesture Responder System</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/javascript-environment">JavaScript Environment</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/direct-manipulation">Direct Manipulation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/colors">Color Reference</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/integration-with-existing-apps">Integration with Existing Apps</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/building-for-tv">Building For TV Devices</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/running-on-device">Running On Device</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/upgrading">Upgrading to new React Native versions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/troubleshooting">Troubleshooting</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/native-modules-setup">Native Modules Setup</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/out-of-tree-platforms">Out-of-Tree Platforms</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides (iOS)<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/native-modules-ios">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/native-components-ios">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/linking-libraries-ios">Linking Libraries</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/running-on-simulator-ios">Running On Simulator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/communication-ios">Communication between native and React Native</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/app-extensions">App Extensions</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides (Android)<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/native-modules-android">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/native-components-android">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/headless-js-android">Headless JS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/signed-apk-android">Publishing to Google Play Store</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/removing-default-permissions">Removing Default Permissions</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Components<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/activityindicator">ActivityIndicator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/button">Button</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/datepickerios">DatePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/drawerlayoutandroid">DrawerLayoutAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/flatlist">FlatList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/image">Image</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/imagebackground">ImageBackground</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/inputaccessoryview">InputAccessoryView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/keyboardavoidingview">KeyboardAvoidingView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/listview">ListView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/maskedviewios">MaskedViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/modal">Modal</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/navigatorios">NavigatorIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/picker">Picker</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/pickerios">PickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/progressbarandroid">ProgressBarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/progressviewios">ProgressViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/refreshcontrol">RefreshControl</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/safeareaview">SafeAreaView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/scrollview">ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/sectionlist">SectionList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/segmentedcontrolios">SegmentedControlIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/slider">Slider</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/snapshotviewios">SnapshotViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/statusbar">StatusBar</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/switch">Switch</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/tabbarios">TabBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/tabbarios-item">TabBarIOS.Item</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/text">Text</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/textinput">TextInput</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/toolbarandroid">ToolbarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/touchablehighlight">TouchableHighlight</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/touchablenativefeedback">TouchableNativeFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/touchableopacity">TouchableOpacity</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/touchablewithoutfeedback">TouchableWithoutFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/view">View</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/viewpagerandroid">ViewPagerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/virtualizedlist">VirtualizedList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/webview">WebView</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">APIs<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.57/accessibilityinfo">AccessibilityInfo</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/actionsheetios">ActionSheetIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/alert">Alert</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/alertios">AlertIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/animated">Animated</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/appregistry">AppRegistry</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/appstate">AppState</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/asyncstorage">AsyncStorage</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/backandroid">BackAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/backhandler">BackHandler</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/cameraroll">CameraRoll</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/clipboard">Clipboard</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/datepickerandroid">DatePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/dimensions">Dimensions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/easing">Easing</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/geolocation">Geolocation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/imageeditor">ImageEditor</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/imagepickerios">ImagePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/imagestore">ImageStore</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/image-style-props">Image Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/interactionmanager">InteractionManager</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/keyboard">Keyboard</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/layout-props">Layout Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/layoutanimation">LayoutAnimation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/linking">Linking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/listviewdatasource">ListViewDataSource</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/netinfo">NetInfo</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/panresponder">PanResponder</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/permissionsandroid">PermissionsAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/pixelratio">PixelRatio</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/0.57/pushnotificationios">PushNotificationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/settings">Settings</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/shadow-props">Shadow Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/share">Share</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/statusbarios">StatusBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/stylesheet">StyleSheet</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/systrace">Systrace</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/text-style-props">Text Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/timepickerandroid">TimePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/toastandroid">ToastAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/transforms">Transforms</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/vibration">Vibration</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/vibrationios">VibrationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.57/view-style-props">View Style Props</a></li></ul></div></div></section></div><script>
|
||
var coll = document.getElementsByClassName('collapsible');
|
||
var checkActiveCategory = true;
|
||
for (var i = 0; i < coll.length; i++) {
|
||
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
||
if (checkActiveCategory){
|
||
for (var j = 0; j < links.length; j++) {
|
||
if (links[j].classList.contains('navListItemActive')){
|
||
coll[i].nextElementSibling.classList.toggle('hide');
|
||
coll[i].childNodes[1].classList.toggle('rotate');
|
||
checkActiveCategory = false;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
coll[i].addEventListener('click', function() {
|
||
var arrow = this.childNodes[1];
|
||
arrow.classList.toggle('rotate');
|
||
var content = this.nextElementSibling;
|
||
content.classList.toggle('hide');
|
||
});
|
||
}
|
||
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
var headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
var el = event.target;
|
||
while(el !== headings){
|
||
if (el.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
break;
|
||
} else{
|
||
el = el.parentNode;
|
||
}
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebook/react-native-website/blob/master/docs/pushnotificationios.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">PushNotificationIOS</h1></header><article><div><span><div class="banner-crna-ejected">
|
||
<h3>Projects with Native Code Only</h3>
|
||
<p>
|
||
This section only applies to projects made with <code>react-native init</code>
|
||
or to those made with Create React Native App which have since ejected. For
|
||
more information about ejecting, please see
|
||
the <a href="https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md" target="_blank">guide</a> on
|
||
the Create React Native App repository.
|
||
</p>
|
||
</div>
|
||
<p>Handle push notifications for your app, including permission handling and icon badge number.</p>
|
||
<p>To get up and running, <a href="https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/AddingCapabilities/AddingCapabilities.html#//apple_ref/doc/uid/TP40012582-CH26-SW6">configure your notifications with Apple</a> and your server-side system.</p>
|
||
<p><a href="/docs/0.57/linking-libraries-ios#manual-linking">Manually link</a> the PushNotificationIOS library</p>
|
||
<ul>
|
||
<li>Add the following to your Project: <code>node_modules/react-native/Libraries/PushNotificationIOS/RCTPushNotification.xcodeproj</code></li>
|
||
<li>Add the following to <code>Link Binary With Libraries</code>: <code>libRCTPushNotification.a</code></li>
|
||
</ul>
|
||
<p>Finally, to enable support for <code>notification</code> and <code>register</code> events you need to augment your AppDelegate.</p>
|
||
<p>At the top of your <code>AppDelegate.m</code>:</p>
|
||
<p><code>#import <React/RCTPushNotificationManager.h></code></p>
|
||
<p>And then in your AppDelegate implementation add the following:</p>
|
||
<pre><code class="hljs"> <span class="hljs-comment">// Required to register for notifications</span>
|
||
<span class="hljs-selector-tag">-</span> (void)<span class="hljs-selector-tag">application</span><span class="hljs-selector-pseudo">:(UIApplication</span> *)<span class="hljs-selector-tag">application</span> <span class="hljs-selector-tag">didRegisterUserNotificationSettings</span><span class="hljs-selector-pseudo">:(UIUserNotificationSettings</span> *)<span class="hljs-selector-tag">notificationSettings</span>
|
||
{
|
||
<span class="hljs-selector-attr">[RCTPushNotificationManager didRegisterUserNotificationSettings:notificationSettings]</span>;
|
||
}
|
||
<span class="hljs-comment">// Required for the register event.</span>
|
||
<span class="hljs-selector-tag">-</span> (void)<span class="hljs-selector-tag">application</span><span class="hljs-selector-pseudo">:(UIApplication</span> *)<span class="hljs-selector-tag">application</span> <span class="hljs-selector-tag">didRegisterForRemoteNotificationsWithDeviceToken</span><span class="hljs-selector-pseudo">:(NSData</span> *)<span class="hljs-selector-tag">deviceToken</span>
|
||
{
|
||
<span class="hljs-selector-attr">[RCTPushNotificationManager didRegisterForRemoteNotificationsWithDeviceToken:deviceToken]</span>;
|
||
}
|
||
<span class="hljs-comment">// Required for the notification event. You must call the completion handler after handling the remote notification.</span>
|
||
<span class="hljs-selector-tag">-</span> (void)<span class="hljs-selector-tag">application</span><span class="hljs-selector-pseudo">:(UIApplication</span> *)<span class="hljs-selector-tag">application</span> <span class="hljs-selector-tag">didReceiveRemoteNotification</span><span class="hljs-selector-pseudo">:(NSDictionary</span> *)<span class="hljs-selector-tag">userInfo</span>
|
||
<span class="hljs-selector-tag">fetchCompletionHandler</span><span class="hljs-selector-pseudo">:(void</span> (^)(UIBackgroundFetchResult))<span class="hljs-selector-tag">completionHandler</span>
|
||
{
|
||
<span class="hljs-selector-attr">[RCTPushNotificationManager didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler]</span>;
|
||
}
|
||
<span class="hljs-comment">// Required for the registrationError event.</span>
|
||
<span class="hljs-selector-tag">-</span> (void)<span class="hljs-selector-tag">application</span><span class="hljs-selector-pseudo">:(UIApplication</span> *)<span class="hljs-selector-tag">application</span> <span class="hljs-selector-tag">didFailToRegisterForRemoteNotificationsWithError</span><span class="hljs-selector-pseudo">:(NSError</span> *)<span class="hljs-selector-tag">error</span>
|
||
{
|
||
<span class="hljs-selector-attr">[RCTPushNotificationManager didFailToRegisterForRemoteNotificationsWithError:error]</span>;
|
||
}
|
||
<span class="hljs-comment">// Required for the localNotification event.</span>
|
||
<span class="hljs-selector-tag">-</span> (void)<span class="hljs-selector-tag">application</span><span class="hljs-selector-pseudo">:(UIApplication</span> *)<span class="hljs-selector-tag">application</span> <span class="hljs-selector-tag">didReceiveLocalNotification</span><span class="hljs-selector-pseudo">:(UILocalNotification</span> *)<span class="hljs-selector-tag">notification</span>
|
||
{
|
||
<span class="hljs-selector-attr">[RCTPushNotificationManager didReceiveLocalNotification:notification]</span>;
|
||
}
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h3>
|
||
<ul>
|
||
<li><a href="/docs/0.57/pushnotificationios#presentLocalNotification"><code>presentLocalNotification</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#schedulelocalnotification"><code>scheduleLocalNotification</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#cancelalllocalnotifications"><code>cancelAllLocalNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#removealldeliverednotifications"><code>removeAllDeliveredNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getdeliverednotifications"><code>getDeliveredNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#removedeliverednotifications"><code>removeDeliveredNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#setapplicationiconbadgenumber"><code>setApplicationIconBadgeNumber</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getapplicationiconbadgenumber"><code>getApplicationIconBadgeNumber</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#cancellocalnotifications"><code>cancelLocalNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getscheduledlocalnotifications"><code>getScheduledLocalNotifications</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#addeventlistener"><code>addEventListener</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#removeeventlistener"><code>removeEventListener</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#requestpermissions"><code>requestPermissions</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#abandonpermissions"><code>abandonPermissions</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#checkpermissions"><code>checkPermissions</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getinitialnotification"><code>getInitialNotification</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#constructor"><code>constructor</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#finish"><code>finish</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getmessage"><code>getMessage</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getsound"><code>getSound</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getcategory"><code>getCategory</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getalert"><code>getAlert</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getcontentavailable"><code>getContentAvailable</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getbadgecount"><code>getBadgeCount</code></a></li>
|
||
<li><a href="/docs/0.57/pushnotificationios#getdata"><code>getData</code></a></li>
|
||
</ul>
|
||
<hr>
|
||
<h1><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reference</h1>
|
||
<h2><a class="anchor" aria-hidden="true" id="methods-1"></a><a href="#methods-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h2>
|
||
<h3><a class="anchor" aria-hidden="true" id="presentlocalnotification"></a><a href="#presentlocalnotification" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>presentLocalNotification()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">presentLocalNotification</span><span class="token punctuation">(</span>details<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Schedules the localNotification for immediate presentation.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>details</td><td>object</td><td>Yes</td><td>See below.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>details is an object containing:</p>
|
||
<ul>
|
||
<li><code>alertBody</code> : The message displayed in the notification alert.</li>
|
||
<li><code>alertAction</code> : The "action" displayed beneath an actionable notification. Defaults to "view";</li>
|
||
<li><code>soundName</code> : The sound played when the notification is fired (optional).</li>
|
||
<li><code>isSilent</code> : If true, the notification will appear without sound (optional).</li>
|
||
<li><code>category</code> : The category of this notification, required for actionable notifications (optional).</li>
|
||
<li><code>userInfo</code> : An optional object containing additional notification data.</li>
|
||
<li><code>applicationIconBadgeNumber</code> (optional) : The number to display as the app's icon badge. The default value of this property is 0, which means that no badge is displayed.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="schedulelocalnotification"></a><a href="#schedulelocalnotification" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>scheduleLocalNotification()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">scheduleLocalNotification</span><span class="token punctuation">(</span>details<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Schedules the localNotification for future presentation.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>details</td><td>object</td><td>Yes</td><td>See below.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>details is an object containing:</p>
|
||
<ul>
|
||
<li><code>fireDate</code> : The date and time when the system should deliver the notification.</li>
|
||
<li><code>alertTitle</code> : The text displayed as the title of the notification alert.</li>
|
||
<li><code>alertBody</code> : The message displayed in the notification alert.</li>
|
||
<li><code>alertAction</code> : The "action" displayed beneath an actionable notification. Defaults to "view";</li>
|
||
<li><code>soundName</code> : The sound played when the notification is fired (optional).</li>
|
||
<li><code>isSilent</code> : If true, the notification will appear without sound (optional).</li>
|
||
<li><code>category</code> : The category of this notification, required for actionable notifications (optional).</li>
|
||
<li><code>userInfo</code> : An optional object containing additional notification data.</li>
|
||
<li><code>applicationIconBadgeNumber</code> (optional) : The number to display as the app's icon badge. Setting the number to 0 removes the icon badge.</li>
|
||
<li><code>repeatInterval</code> : The interval to repeat as a string. Possible values: <code>minute</code>, <code>hour</code>, <code>day</code>, <code>week</code>, <code>month</code>, <code>year</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="cancelalllocalnotifications"></a><a href="#cancelalllocalnotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>cancelAllLocalNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">cancelAllLocalNotifications</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Cancels all scheduled localNotifications</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="removealldeliverednotifications"></a><a href="#removealldeliverednotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>removeAllDeliveredNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">removeAllDeliveredNotifications</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Remove all delivered notifications from Notification Center</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getdeliverednotifications"></a><a href="#getdeliverednotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getDeliveredNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">getDeliveredNotifications</span><span class="token punctuation">(</span>callback<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Provides you with a list of the app’s notifications that are still displayed in Notification Center</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>callback</td><td>function</td><td>Yes</td><td>Function which receive an array of delivered notifications.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>A delivered notification is an object containing:</p>
|
||
<ul>
|
||
<li><code>identifier</code> : The identifier of this notification.</li>
|
||
<li><code>title</code> : The title of this notification.</li>
|
||
<li><code>body</code> : The body of this notification.</li>
|
||
<li><code>category</code> : The category of this notification, if has one.</li>
|
||
<li><code>userInfo</code> : An optional object containing additional notification data.</li>
|
||
<li><code>thread-id</code> : The thread identifier of this notification, if has one.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="removedeliverednotifications"></a><a href="#removedeliverednotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>removeDeliveredNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">removeDeliveredNotifications</span><span class="token punctuation">(</span>identifiers<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Removes the specified notifications from Notification Center</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>identifiers</td><td>array</td><td>Yes</td><td>Array of notification identifiers.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="setapplicationiconbadgenumber"></a><a href="#setapplicationiconbadgenumber" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>setApplicationIconBadgeNumber()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">setApplicationIconBadgeNumber</span><span class="token punctuation">(</span>number<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Sets the badge number for the app icon on the home screen</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>number</td><td>number</td><td>Yes</td><td>Badge number for the app icon.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getapplicationiconbadgenumber"></a><a href="#getapplicationiconbadgenumber" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getApplicationIconBadgeNumber()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">getApplicationIconBadgeNumber</span><span class="token punctuation">(</span>callback<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the current badge number for the app icon on the home screen</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>callback</td><td>function</td><td>Yes</td><td>A function that will be passed the current badge number.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="cancellocalnotifications"></a><a href="#cancellocalnotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>cancelLocalNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">cancelLocalNotifications</span><span class="token punctuation">(</span>userInfo<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Cancel local notifications.</p>
|
||
<p>Optionally restricts the set of canceled notifications to those notifications whose <code>userInfo</code> fields match the corresponding fields in the <code>userInfo</code> argument.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>userInfo</td><td>object</td><td>No</td><td></td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getscheduledlocalnotifications"></a><a href="#getscheduledlocalnotifications" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getScheduledLocalNotifications()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">getScheduledLocalNotifications</span><span class="token punctuation">(</span>callback<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the local notifications that are currently scheduled.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>callback</td><td>function</td><td>Yes</td><td>A function that will be passed an array of objects describing local notifications.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="addeventlistener"></a><a href="#addeventlistener" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>addEventListener()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">addEventListener</span><span class="token punctuation">(</span>type<span class="token punctuation">,</span> handler<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Attaches a listener to remote or local notification events while the app is running in the foreground or the background.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>type</td><td>string</td><td>Yes</td><td>Event type.</td></tr>
|
||
<tr><td>handler</td><td>function</td><td>Yes</td><td>Listener.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Valid events are:</p>
|
||
<ul>
|
||
<li><code>notification</code> : Fired when a remote notification is received. The handler will be invoked with an instance of <code>PushNotificationIOS</code>.</li>
|
||
<li><code>localNotification</code> : Fired when a local notification is received. The handler will be invoked with an instance of <code>PushNotificationIOS</code>.</li>
|
||
<li><code>register</code>: Fired when the user registers for remote notifications. The handler will be invoked with a hex string representing the deviceToken.</li>
|
||
<li><code>registrationError</code>: Fired when the user fails to register for remote notifications. Typically occurs when APNS is having issues, or the device is a simulator. The handler will be invoked with {message: string, code: number, details: any}.</li>
|
||
</ul>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="removeeventlistener"></a><a href="#removeeventlistener" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>removeEventListener()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">removeEventListener</span><span class="token punctuation">(</span>type<span class="token punctuation">,</span> handler<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Removes the event listener. Do this in <code>componentWillUnmount</code> to prevent memory leaks</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>type</td><td>string</td><td>Yes</td><td>Event type.</td></tr>
|
||
<tr><td>handler</td><td>function</td><td>Yes</td><td>Listener.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="requestpermissions"></a><a href="#requestpermissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>requestPermissions()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">requestPermissions</span><span class="token punctuation">(</span><span class="token punctuation">[</span>permissions<span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Requests notification permissions from iOS, prompting the user's dialog box. By default, it will request all notification permissions, but a subset of these can be requested by passing a map of requested permissions. The following permissions are supported:</p>
|
||
<ul>
|
||
<li><code>alert</code></li>
|
||
<li><code>badge</code></li>
|
||
<li><code>sound</code></li>
|
||
</ul>
|
||
<p>If a map is provided to the method, only the permissions with truthy values will be requested.</p>
|
||
<p>This method returns a promise that will resolve when the user accepts, rejects, or if the permissions were previously rejected. The promise resolves to the current state of the permission.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>permissions</td><td>array</td><td>No</td><td>alert, badge, or sound</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="abandonpermissions"></a><a href="#abandonpermissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>abandonPermissions()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">abandonPermissions</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Unregister for all remote notifications received via Apple Push Notification service.</p>
|
||
<p>You should call this method in rare circumstances only, such as when a new version of the app removes support for all types of remote notifications. Users can temporarily prevent apps from receiving remote notifications through the Notifications section of the Settings app. Apps unregistered through this method can always re-register.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="checkpermissions"></a><a href="#checkpermissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>checkPermissions()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">checkPermissions</span><span class="token punctuation">(</span>callback<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>See what push permissions are currently enabled.</p>
|
||
<p><strong>Parameters:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>callback</td><td>function</td><td>Yes</td><td>See below.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p><code>callback</code> will be invoked with a <code>permissions</code> object:</p>
|
||
<ul>
|
||
<li><code>alert</code> :boolean</li>
|
||
<li><code>badge</code> :boolean</li>
|
||
<li><code>sound</code> :boolean</li>
|
||
</ul>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getinitialnotification"></a><a href="#getinitialnotification" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getInitialNotification()</code></h3>
|
||
<pre><code class="hljs css language-jsx">PushNotificationIOS<span class="token punctuation">.</span><span class="token function">getInitialNotification</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>This method returns a promise. If the app was launched by a push notification, this promise resolves to an object of type <code>PushNotificationIOS</code>. Otherwise, it resolves to <code>null</code>.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="constructor"></a><a href="#constructor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>constructor()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">constructor</span><span class="token punctuation">(</span>nativeNotif<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>You will never need to instantiate <code>PushNotificationIOS</code> yourself. Listening to the <code>notification</code> event and invoking <code>getInitialNotification</code> is sufficient.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="finish"></a><a href="#finish" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>finish()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">finish</span><span class="token punctuation">(</span>fetchResult<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>This method is available for remote notifications that have been received via: <code>application:didReceiveRemoteNotification:fetchCompletionHandler:</code> <a href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didReceiveRemoteNotification:fetchCompletionHandler">https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didReceiveRemoteNotification:fetchCompletionHandler</a>:</p>
|
||
<p>Call this to execute when the remote notification handling is complete. When calling this block, pass in the fetch result value that best describes the results of your operation. You <em>must</em> call this handler and should do so as soon as possible. For a list of possible values, see <code>PushNotificationIOS.FetchResult</code>.</p>
|
||
<p>If you do not call this method your background remote notifications could be throttled, to read more about it see the above documentation link.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getmessage"></a><a href="#getmessage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getMessage()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>An alias for <code>getAlert</code> to get the notification's main message string</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getsound"></a><a href="#getsound" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getSound()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getSound</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the sound string from the <code>aps</code> object</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getcategory"></a><a href="#getcategory" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getCategory()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getCategory</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the category string from the <code>aps</code> object</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getalert"></a><a href="#getalert" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getAlert()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getAlert</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the notification's main message from the <code>aps</code> object</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getcontentavailable"></a><a href="#getcontentavailable" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getContentAvailable()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getContentAvailable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the content-available number from the <code>aps</code> object</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getbadgecount"></a><a href="#getbadgecount" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getBadgeCount()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getBadgeCount</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the badge count number from the <code>aps</code> object</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="getdata"></a><a href="#getdata" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>getData()</code></h3>
|
||
<pre><code class="hljs css language-jsx"><span class="token function">getData</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre>
|
||
<p>Gets the data object on the notif</p>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/0.57/pixelratio"><span class="arrow-prev">← </span><span class="function-name-prevnext">PixelRatio</span></a><a class="docs-next button" href="/docs/0.57/settings"><span>Settings</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#presentlocalnotification"><code>presentLocalNotification()</code></a></li><li><a href="#schedulelocalnotification"><code>scheduleLocalNotification()</code></a></li><li><a href="#cancelalllocalnotifications"><code>cancelAllLocalNotifications()</code></a></li><li><a href="#removealldeliverednotifications"><code>removeAllDeliveredNotifications()</code></a></li><li><a href="#getdeliverednotifications"><code>getDeliveredNotifications()</code></a></li><li><a href="#removedeliverednotifications"><code>removeDeliveredNotifications()</code></a></li><li><a href="#setapplicationiconbadgenumber"><code>setApplicationIconBadgeNumber()</code></a></li><li><a href="#getapplicationiconbadgenumber"><code>getApplicationIconBadgeNumber()</code></a></li><li><a href="#cancellocalnotifications"><code>cancelLocalNotifications()</code></a></li><li><a href="#getscheduledlocalnotifications"><code>getScheduledLocalNotifications()</code></a></li><li><a href="#addeventlistener"><code>addEventListener()</code></a></li><li><a href="#removeeventlistener"><code>removeEventListener()</code></a></li><li><a href="#requestpermissions"><code>requestPermissions()</code></a></li><li><a href="#abandonpermissions"><code>abandonPermissions()</code></a></li><li><a href="#checkpermissions"><code>checkPermissions()</code></a></li><li><a href="#getinitialnotification"><code>getInitialNotification()</code></a></li><li><a href="#constructor"><code>constructor()</code></a></li><li><a href="#finish"><code>finish()</code></a></li><li><a href="#getmessage"><code>getMessage()</code></a></li><li><a href="#getsound"><code>getSound()</code></a></li><li><a href="#getcategory"><code>getCategory()</code></a></li><li><a href="#getalert"><code>getAlert()</code></a></li><li><a href="#getcontentavailable"><code>getContentAvailable()</code></a></li><li><a href="#getbadgecount"><code>getBadgeCount()</code></a></li><li><a href="#getdata"><code>getData()</code></a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>Docs</h5><a href="/docs/getting-started">Getting Started</a><a href="/docs/tutorial">Tutorial</a><a href="/docs/components-and-apis">Components and APIs</a><a href="/docs/more-resources">More Resources</a></div><div><h5>Community</h5><a href="/help">The React Native Community</a><a href="/showcase">Who's using React Native?</a><a href="https://stackoverflow.com/questions/tagged/react-native" target="_blank">Ask Questions on Stack Overflow</a><a href="https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md">Contributor Guide</a><a href="https://dev.to/t/reactnative" target="_blank">DEV Community</a></div><div><h5>More Resources</h5><a href="/blog">Blog</a><a href="https://twitter.com/reactnative" target="_blank">Twitter</a><a href="https://github.com/facebook/react-native" target="_blank">GitHub</a><a href="https://reactjs.org" target="_blank">React</a></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2020 Facebook Inc.</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>window.fbAsyncInit = function() {FB.init({appId:'1677033832619985',xfbml:true,version:'v2.7'});};(function(d, s, id){var js, fjs = d.getElementsByTagName(s)[0];if (d.getElementById(id)) {return;}js = d.createElement(s); js.id = id;js.src = '//connect.facebook.net/en_US/sdk.js';fjs.parentNode.insertBefore(js, fjs);}(document, 'script','facebook-jssdk'));
|
||
</script><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script><script>
|
||
document.addEventListener('keyup', function(e) {
|
||
if (e.target !== document.body) {
|
||
return;
|
||
}
|
||
// keyCode for '/' (slash)
|
||
if (e.keyCode === 191) {
|
||
const search = document.getElementById('search_input_react');
|
||
search && search.focus();
|
||
}
|
||
});
|
||
</script><script>
|
||
var search = docsearch({
|
||
|
||
apiKey: '2c98749b4a1e588efec53b2acec13025',
|
||
indexName: 'react-native-versions',
|
||
inputSelector: '#search_input_react',
|
||
algoliaOptions: {"facetFilters":["tags:0.57"],"hitsPerPage":5}
|
||
});
|
||
</script></body></html> |