Skip to content

Commit 5fba12b

Browse files
authored
Merge pull request #60 from Soomgo-Mobile/v10-telemetry-docs
docs: Add telemetry callbacks
2 parents cb4d678 + 7187cc6 commit 5fba12b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,16 @@ export default CodePush({
217217
> The URL for fetching the release history should point to the resource location generated by the CLI tool.
218218
219219

220+
#### 4-1. Telemetry Callbacks
221+
222+
Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-native-code-push/blob/f0d26f7614af41c6dd4daecd9f7146e2383b2b0d/typings/react-native-code-push.d.ts#L76-L95) type for more details.
223+
- **onUpdateSuccess:** Triggered when the update bundle is executed successfully.
224+
- **onUpdateRollback:** Triggered when there is an issue executing the update bundle, leading to a rollback.
225+
- **onDownloadStart:** Triggered when the bundle download begins.
226+
- **onDownloadSuccess:** Triggered when the bundle download completes successfully.
227+
- **onSyncError:** Triggered when an unknown error occurs during the update process. (`CodePush.SyncStatus.UNKNOWN_ERROR` status)
228+
229+
220230
### 5. Configure the CLI Tool
221231

222232
> [!TIP]

0 commit comments

Comments
 (0)