Skip to content

docs: Update react-native download API and event listeners#95

Merged
syed-tp merged 3 commits intomainfrom
update/rn_dolwnload_docs
Mar 5, 2026
Merged

docs: Update react-native download API and event listeners#95
syed-tp merged 3 commits intomainfrom
update/rn_dolwnload_docs

Conversation

@syed-tp
Copy link
Contributor

@syed-tp syed-tp commented Mar 4, 2026

  • Add documentation for the new startDownload method.
  • Document new event listeners: onDownloadStarted, onDownloadPaused, onDownloadResumed, onDownloadCompleted, onDownloadFailed, and onDownloadDeleted.
  • Add deprecation notice for onDownloadStateChanged.
  • Add a comprehensive React Native usage example.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the React Native TPStreams SDK's download functionality. It introduces a new method for initiating downloads and provides a more robust event-driven system for tracking download progress and state changes. The update aims to improve developer experience by offering clearer guidance and more precise control over offline video management, alongside a practical usage example.

Highlights

  • New Download Initiation Method: Documentation for the new startDownload method has been added, detailing its parameters and usage for initiating video downloads.
  • Enhanced Event Listeners: New dedicated event listeners such as onDownloadStarted, onDownloadPaused, onDownloadResumed, onDownloadCompleted, onDownloadFailed, and onDownloadDeleted are now documented, offering more granular control over download state changes.
  • Deprecation Notice: The onDownloadStateChanged event listener has been marked as deprecated, with a recommendation to use the new specific event listeners for better precision and type safety.
  • Comprehensive Usage Example: A detailed React Native usage example has been included to demonstrate how to initialize the progress listener and subscribe to the new download events.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/mobile-sdk/react-native-sdk/downloads.md
    • Added documentation for the new startDownload API, including its parameters and usage.
    • Introduced and documented new specific download event listeners: onDownloadStarted, onDownloadPaused, onDownloadResumed, onDownloadCompleted, onDownloadFailed, and onDownloadDeleted.
    • Added a deprecation notice for the onDownloadStateChanged event, recommending the use of new dedicated events.
    • Updated the structure of the documentation to better categorize download initiation, management, and events.
    • Included a comprehensive React Native code example demonstrating the initialization of progress listeners and subscription to new download events.
    • Refined the descriptions for DownloadItem and DownloadError data structures.
Activity
  • No human activity has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly improves the documentation for the React Native SDK's download functionality. It introduces the new startDownload method, documents new event listeners, adds a deprecation notice for onDownloadStateChanged, and provides a comprehensive usage example. The new structure is much clearer and more helpful for developers. I've found one issue in the new usage example regarding resource cleanup which should be addressed to ensure users write robust code.

Note: Security Review has been skipped due to the limited scope of the PR.

@syed-tp syed-tp merged commit a92da86 into main Mar 5, 2026
3 checks passed
@syed-tp syed-tp deleted the update/rn_dolwnload_docs branch March 5, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant