-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated readme document and code formating
- Loading branch information
1 parent
8b1a944
commit 4f6dc02
Showing
3 changed files
with
63 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,64 @@ | ||
# 1Flow-Segment | ||
|
||
A description of this package. | ||
# 1Flow Mobile Plugin Destination | ||
|
||
1Flow is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses. | ||
|
||
Using 1Flow, you can reach users _in-the-moment_ while they are interacting with your website or application, to collect highly contextual user insights that help you improve your product offering and customer experience | ||
|
||
This destination is maintained by 1Flow. For any issues with the destination, [contact Support team](mailto:support@1flow.app). | ||
|
||
## Getting started | ||
|
||
1. From the Segment web app, click **Catalog**, then search for **1Flow Mobile Plugin**. | ||
2. Click **Add Destination**. | ||
4. Select an existing Source to connect to 1Flow Mobile Plugin. | ||
5. Go to 1flow.ai -> Settings -> Project Settings, copy the 1Flow project key, and paste it into the Destination Settings in Segment. | ||
6. Depending on the mobile source you’ve selected, include 1Flow's library by adding the following lines to your dependency configuration. | ||
|
||
## Add Package to your XCode Project | ||
### Step 1: Add Segment1Flow Package using Swift Package Manager | ||
|
||
In the Xcode File menu, click Add Packages. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo. | ||
|
||
https://github.com/1Flow-Inc/Segment1Flow | ||
|
||
You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button. | ||
|
||
### Step 2: Initialise Segment and Add 1Fow Destination | ||
|
||
``` | ||
let config = Configuration(writeKey: "YOUR_WRITE_KEY_HERE") | ||
let analytics = Analytics(configuration: config) | ||
analytics.add(plugin: OneFlowDestination()) | ||
``` | ||
## Supported methods | ||
|
||
### Identify | ||
An example call would look like: | ||
|
||
```swift | ||
analytics.identify(userId: "peter@example.com", traits: [ | ||
"name": "Peter Gibbons", | ||
"email": "peter@example.com", | ||
"mobile": 1234567890 | ||
]) | ||
``` | ||
When you call identify method of segment, it will be equivalent to `logUser` of 1Flow. `userId` will be `userID` and `traits` will be `userDetails`. | ||
|
||
### Track | ||
An example call would look like: | ||
|
||
```swift | ||
analytics.track(name: "ButtonClicked") | ||
``` | ||
Any value passed in `name`, will be eventName and if you have passed any event property, then it will be event `parameters`. | ||
|
||
### Screen | ||
|
||
Send Screenview events to record which mobile app screens users have viewed. For example: | ||
|
||
```swift | ||
analytics.screen(title: "Home") | ||
``` | ||
|
||
Segment sends Screen calls to 1Flow as a `screen_[name]` event (or `screen_view` if a screen name isn't provided). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters