@segment/analytics-react-native-plugin-branch
v1.1.2
Published
The hassle-free way to add Segment analytics to your React-Native app.
Downloads
104
Maintainers
Readme
@segment/analytics-react-native-plugin-branch
DestinationPlugin
for Branch. Wraps react-native-branch
.
Installation
You need to install the @segment/analytics-react-native-plugin-branch
and the react-native-branch
dependency.
Using NPM:
npm install --save @segment/analytics-react-native-plugin-branch react-native-branch
Using Yarn:
yarn add @segment/analytics-react-native-plugin-branch react-native-branch
Run pod install
after the installation to autolink the Branch SDK.
See Branch React Native SDK
for more details of this dependency.
Usage
Follow the instructions for adding plugins on the main Analytics client:
In your code where you initialize the analytics client call the .add(plugin)
method with an BranchPlugin
instance:
import { createClient } from '@segment/analytics-react-native';
import { BranchPlugin } from '@segment/analytics-react-native-plugin-branch';
const segmentClient = createClient({
writeKey: 'SEGMENT_KEY'
});
segmentClient.add({ plugin: new BranchPlugin() });
Support
Please use Github issues, Pull Requests, or feel free to reach out to our support team.
Integrating with Segment
Interested in integrating your service with us? Check out our Partners page for more details.
License
MIT License
Copyright (c) 2022 Segment
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.