You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Defined in: [enums/CheckFrequency.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L4)
10
-
11
9
Indicates when you would like to check for (and install) updates from the CodePush server.
12
10
13
11
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates when you would like to check for (and install) updates from the CodePu
16
14
17
15
> **MANUAL**: `2`
18
16
19
-
Defined in: [enums/CheckFrequency.enum.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L18)
20
-
21
17
Don't automatically check for updates, but only do it when `sync()` is manually called in app code.
22
18
23
19
---
@@ -26,8 +22,6 @@ Don't automatically check for updates, but only do it when `sync()` is manually
26
22
27
23
> **ON_APP_RESUME**: `1`
28
24
29
-
Defined in: [enums/CheckFrequency.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L13)
30
-
31
25
When the app re-enters the foreground after being "backgrounded" (user pressed the home button, app launches a separate payment process, etc.)
32
26
33
27
---
@@ -36,6 +30,4 @@ When the app re-enters the foreground after being "backgrounded" (user pressed t
36
30
37
31
> **ON_APP_START**: `0`
38
32
39
-
Defined in: [enums/CheckFrequency.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L8)
40
-
41
33
When the app is fully initialized (or more specifically, when the root component is mounted).
Defined in: [enums/DeploymentStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L4)
10
-
11
9
Indicates the status of a deployment (after installing and restarting).
12
10
13
11
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the status of a deployment (after installing and restarting).
16
14
17
15
> **FAILED**: `"DeploymentFailed"`
18
16
19
-
Defined in: [enums/DeploymentStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L8)
20
-
21
17
The deployment failed (and was rolled back).
22
18
23
19
---
@@ -26,6 +22,4 @@ The deployment failed (and was rolled back).
26
22
27
23
> **SUCCEEDED**: `"DeploymentSucceeded"`
28
24
29
-
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L13)
Defined in: [enums/InstallMode.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L6)
10
-
11
9
Indicates when you would like an installed update to actually be applied.
12
10
13
11
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates when you would like an installed update to actually be applied.
16
14
17
15
> **IMMEDIATE**: `number`
18
16
19
-
Defined in: [enums/InstallMode.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L12)
20
-
21
17
Indicates that you want to install the update and restart the app immediately.
22
18
23
19
This value is appropriate for debugging scenarios as well as when displaying an update prompt to the user, since they would expect to see the changes immediately after accepting the installation. Additionally, this mode can be used to enforce mandatory updates, since it removes the potentially undesired latency between the update installation and the next time the end user restarts or resumes the app.
@@ -28,8 +24,6 @@ This value is appropriate for debugging scenarios as well as when displaying an
28
24
29
25
> **ON_NEXT_RESTART**: `number`
30
26
31
-
Defined in: [enums/InstallMode.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L19)
32
-
33
27
Indicates that you want to install the update, but not forcibly restart the app.
34
28
35
29
When the app is "naturally" restarted (due the OS or end user killing it), the update will be seamlessly picked up. This value is appropriate when performing silent updates, since it would likely be disruptive to the end user if the app suddenly restarted out of nowhere, since they wouldn't have realized an update was even downloaded. This is the default mode used for both the `sync` and `LocalPackage.install` methods.
@@ -40,8 +34,6 @@ When the app is "naturally" restarted (due the OS or end user killing it), the u
40
34
41
35
> **ON_NEXT_RESUME**: `number`
42
36
43
-
Defined in: [enums/InstallMode.enum.ts:27](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L27)
44
-
45
37
Indicates that you want to install the update, but don't want to restart the app until the next time the end user resumes it from the background.
46
38
47
39
This way, you don't disrupt their current session,but you can get the update in front of them sooner than having to wait for the next natural restart.
@@ -53,8 +45,6 @@ This value is appropriate for silent installs that can be applied on resume in a
53
45
54
46
> **ON_NEXT_SUSPEND**: `number`
55
47
56
-
Defined in: [enums/InstallMode.enum.ts:34](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L34)
57
-
58
48
Indicates that you want to install the update when the app is in the background,
59
49
but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
60
50
so that user context isn't lost unless the app suspension is long enough to not matter.
Defined in: [enums/SyncStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L4)
10
-
11
9
Indicates the current status of a sync operation.
12
10
13
11
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the current status of a sync operation.
16
14
17
15
> **AWAITING_USER_ACTION**: `6`
18
16
19
-
Defined in: [enums/SyncStatus.enum.ts:42](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L42)
20
-
21
17
An update is available, and a confirmation dialog was shown
22
18
to the end user. (This is only applicable when the `updateDialog` is used)
23
19
@@ -27,8 +23,6 @@ to the end user. (This is only applicable when the `updateDialog` is used)
27
23
28
24
> **CHECKING_FOR_UPDATE**: `5`
29
25
30
-
Defined in: [enums/SyncStatus.enum.ts:36](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L36)
31
-
32
26
The CodePush server is being queried for an update.
33
27
34
28
---
@@ -37,8 +31,6 @@ The CodePush server is being queried for an update.
37
31
38
32
> **DOWNLOADING_PACKAGE**: `7`
39
33
40
-
Defined in: [enums/SyncStatus.enum.ts:47](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L47)
41
-
42
34
An available update is being downloaded from the CodePush server.
43
35
44
36
---
@@ -47,8 +39,6 @@ An available update is being downloaded from the CodePush server.
47
39
48
40
> **INSTALLING_UPDATE**: `8`
49
41
50
-
Defined in: [enums/SyncStatus.enum.ts:52](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L52)
51
-
52
42
An available update was downloaded and is about to be installed.
53
43
54
44
---
@@ -57,8 +47,6 @@ An available update was downloaded and is about to be installed.
57
47
58
48
> **SYNC_IN_PROGRESS**: `4`
59
49
60
-
Defined in: [enums/SyncStatus.enum.ts:31](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L31)
61
-
62
50
There is an ongoing `sync` operation running which prevents the current call from being executed.
63
51
64
52
---
@@ -67,8 +55,6 @@ There is an ongoing `sync` operation running which prevents the current call fro
67
55
68
56
> **UNKNOWN_ERROR**: `3`
69
57
70
-
Defined in: [enums/SyncStatus.enum.ts:26](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L26)
71
-
72
58
The `sync` operation encountered an unknown error.
73
59
74
60
---
@@ -77,8 +63,6 @@ The `sync` operation encountered an unknown error.
77
63
78
64
> **UP_TO_DATE**: `0`
79
65
80
-
Defined in: [enums/SyncStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L8)
81
-
82
66
The app is fully up-to-date with the configured release channel.
83
67
84
68
---
@@ -87,8 +71,6 @@ The app is fully up-to-date with the configured release channel.
87
71
88
72
> **UPDATE_IGNORED**: `2`
89
73
90
-
Defined in: [enums/SyncStatus.enum.ts:21](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L21)
91
-
92
74
The app had an optional update which the end user chose to ignore.
93
75
(This is only applicable when the `updateDialog` is used)
94
76
@@ -98,8 +80,6 @@ The app had an optional update which the end user chose to ignore.
98
80
99
81
> **UPDATE_INSTALLED**: `1`
100
82
101
-
Defined in: [enums/SyncStatus.enum.ts:15](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L15)
102
-
103
83
An available update has been installed and will be run either immediately after the
104
84
`syncStatusChangedCallback` function returns or the next time the app resumes/restarts,
105
85
depending on the `InstallMode` specified in `SyncOptions`
Defined in: [enums/UpdateState.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L6)
10
-
11
9
Indicates the state that an update is currently in.
12
10
13
11
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the state that an update is currently in.
16
14
17
15
> **LATEST**: `number`
18
16
19
-
Defined in: [enums/UpdateState.enum.ts:24](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L24)
20
-
21
17
Indicates than an update represents the latest available release, and can be either currently running or pending.
22
18
23
19
---
@@ -26,8 +22,6 @@ Indicates than an update represents the latest available release, and can be eit
26
22
27
23
> **PENDING**: `number`
28
24
29
-
Defined in: [enums/UpdateState.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L19)
30
-
31
25
Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it.
32
26
33
27
This can be useful for determining whether there is a pending update, which you may want to force a programmatic restart (via `restartApp`) in order to apply.
@@ -38,8 +32,6 @@ This can be useful for determining whether there is a pending update, which you
38
32
39
33
> **RUNNING**: `number`
40
34
41
-
Defined in: [enums/UpdateState.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L12)
42
-
43
35
Indicates that an update represents the version of the app that is currently running.
44
36
45
37
This can be useful for identifying attributes about the app, for scenarios such as displaying the release description in a "what's new?" dialog or reporting the latest version to an analytics and/or crash reporting service.
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/allowRestart.ts#L8)
12
-
13
11
Allow CodePush to restart the app.
14
12
15
13
This is an advanced API and is only necessary if your app explicitly disallowed restarts via the `disallowRestart` method.
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/checkForUpdates.ts#L18)
12
-
13
11
Asks the CodePush service whether the configured app release channel has an update available.
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/clearUpdates.ts#L10)
12
-
13
11
Clears all downloaded CodePush updates.
14
12
15
13
This is useful when switching to a different release channel which may have an older release than the current package.
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/disallowRestart.ts#L8)
12
-
13
11
Forbid CodePush to restart the app.
14
12
15
13
This is an advanced API, and is useful when a component within your app (for example an onboarding process) needs to ensure that no end-user interruptions can occur during its lifetime.
0 commit comments