From 176121dffb7620026063a8ce6536c9b1c4424836 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Altun?= Date: Fri, 10 Nov 2023 00:00:21 +0300 Subject: [PATCH] Update api-js.md (#2252) Co-authored-by: velimir-jankovic <84719115+velimir-jankovic@users.noreply.github.com> --- docs/api-js.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-js.md b/docs/api-js.md index 4bdb27cb5..0f946a102 100644 --- a/docs/api-js.md +++ b/docs/api-js.md @@ -128,7 +128,7 @@ The `codePush` decorator accepts an "options" object that allows you to customiz * __minimumBackgroundDuration__ *(Number)* - Specifies the minimum number of seconds that the app needs to have been in the background before restarting the app. This property only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME` or `InstallMode.ON_NEXT_SUSPEND`, and can be useful for getting your update in front of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying the update immediately after a resume or unless the app suspension is long enough to not matter, regardless how long it was in the background. -* __updateDialog__ *(UpdateDialogOptions)* - An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available, and if so, what strings to use. Defaults to `null`, which has the effect of disabling the dialog completely. Setting this to any truthy value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as overriding one or more of the default strings. Before enabling this option within an App Store-distributed app, please refer to [this note](https://github.com/microsoft/react-native-code-push#user-content-apple-note). +* __updateDialog__ *(UpdateDialogOptions)* - An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available, and if so, what strings to use. Defaults to `null`, which has the effect of disabling the dialog completely. Setting this to any truthy value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as overriding one or more of the default strings. Before enabling this option within an App Store-distributed app, please refer to [this note](https://github.com/microsoft/react-native-code-push#app-store). The following list represents the available options and their defaults: