-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
15 lines (15 loc) · 9.13 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@batch.com/react-native-plugin</title><meta name="description" content="Documentation for @batch.com/react-native-plugin"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">@batch.com/react-native-plugin</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@batch.com/react-native-plugin</h2></div><div class="tsd-panel tsd-typography"><img src="https://static.batch.com/documentation/Readmes/[email protected]" srcset="https://static.batch.com/documentation/Readmes/logo_batch_full_178.png 1x" alt="Batch Logo" />
<a id="md:batch-react-native-plugin" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Batch React-Native Plugin<a href="#md:batch-react-native-plugin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>The Batch React-Native Plugin allows you to build meaningful communication experience in your Android/iOS app through highly personalized push notifications & In-App messages.</p>
<p>Our <a href="https://doc.batch.com/react-native/prerequisites">📕 setup documentation</a> details the steps to take for an easy and successful integration.</p>
<a id="md:prerequisites" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Prerequisites<a href="#md:prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>As this plugin is built over Batch's Native SDKs, their respective Android and iOS requirements apply.</p>
<a id="md:documentation" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Documentation<a href="#md:documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><ul>
<li><a href="https://doc.batch.com/react-native/prerequisites">Setup guide</a>: start your implementation here!</li>
<li><a href="https://help.batch.com/en/">Help center</a>: answers to most questions you may have during the integration</li>
<li><a href="https://batchlabs.github.io/Batch-React-Native-Plugin/">API reference</a>: this documents each of the classes and methods in the Batch React-Native Plugin</li>
</ul>
<p>You may also find this guide useful to review after integration to make sure you're ready to go live: <a href="https://help.batch.com/en/articles/2669866-how-can-i-test-the-integration-on-ios">How can I test the integration on iOS?</a> / <a href="https://help.batch.com/en/articles/2672749-how-can-i-test-the-integration-on-android">How can I test the integration on Android?</a></p>
<a id="md:releases" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Releases<a href="#md:releases" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Release instructions are detailed in <a href="https://github.com/BatchLabs/Batch-React-Native-Plugin/blob/master/RELEASING.md">RELEASING.md</a>.</p>
<a id="md:building" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Building<a href="#md:building" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Build instructions are detailed in <a href="https://github.com/BatchLabs/Batch-React-Native-Plugin/blob/master/BUILDING.md">BUILDING.md</a>.</p>
<a id="md:contributing" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Contributing<a href="#md:contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Please refer to our <a href="https://github.com/BatchLabs/Batch-React-Native-Plugin/blob/master/CONTRIBUTING.md">contributing guidelines</a>.</p>
<a id="md:credits" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Credits<a href="#md:credits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Batch-React-Native-Plugin is based on <a href="https://github.com/bamlab/">bamlab's</a> <a href="https://github.com/bamlab/react-native-batch-push">React Native plugin</a>.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:batch-react-native-plugin"><span>Batch <wbr/>React-<wbr/>Native <wbr/>Plugin</span></a><a href="#md:prerequisites"><span>Prerequisites</span></a><a href="#md:documentation"><span>Documentation</span></a><a href="#md:releases"><span>Releases</span></a><a href="#md:building"><span>Building</span></a><a href="#md:contributing"><span>Contributing</span></a><a href="#md:credits"><span>Credits</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@batch.com/react-native-plugin</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>