-
Notifications
You must be signed in to change notification settings - Fork 367
Add flush policy docs #4480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add flush policy docs #4480
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @niallzato - thanks for submitting this. I've left some comments (and a few questions) to align this a bit more with our style guide. After that, we'll add this to our docs!
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
// ... | ||
flushPolicies: policies, | ||
}); | ||
// If we detect the user disconnects from the network remove all flush policies, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do the instances of we
in lines 377-380 all refer to Segment
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rchinn-segment thanks for all the suggestions. Correct, we are referring to Segment for these instances. Specifically, the Segment library initialized in the app. We could say something like the following, perhaps:
// that way the Segment client won't keep attempting to send events to Segment, but they will still // be stored for future upload. // If the network comes back up, the Segment client adds the policies back
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds great @niallzato - will get these updates in our upcoming docs deploy!
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
…index.md Co-authored-by: rchinn-segment <[email protected]>
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/mobile/react-native/index.md
Outdated
Show resolved
Hide resolved
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Proposed changes
Add flush policy docs, copied from here: https://github.com/segmentio/analytics-react-native#controlling-upload-with-flush-policies