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
Copy file name to clipboardExpand all lines: docs/api-js/enumerations/CheckFrequency.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Enumeration: CheckFrequency
8
8
9
-
Defined in: [enums/CheckFrequency.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L4)
9
+
Defined in: [enums/CheckFrequency.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L4)
10
10
11
11
Indicates when you would like to check for (and install) updates from the CodePush server.
12
12
@@ -16,7 +16,7 @@ Indicates when you would like to check for (and install) updates from the CodePu
16
16
17
17
> **MANUAL**: `2`
18
18
19
-
Defined in: [enums/CheckFrequency.enum.ts:18](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L18)
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
20
21
21
Don't automatically check for updates, but only do it when `sync()` is manually called in app code.
22
22
@@ -26,7 +26,7 @@ Don't automatically check for updates, but only do it when `sync()` is manually
26
26
27
27
> **ON_APP_RESUME**: `1`
28
28
29
-
Defined in: [enums/CheckFrequency.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L13)
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
30
31
31
When the app re-enters the foreground after being "backgrounded" (user pressed the home button, app launches a separate payment process, etc.)
32
32
@@ -36,6 +36,6 @@ When the app re-enters the foreground after being "backgrounded" (user pressed t
36
36
37
37
> **ON_APP_START**: `0`
38
38
39
-
Defined in: [enums/CheckFrequency.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L8)
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
40
41
41
When the app is fully initialized (or more specifically, when the root component is mounted).
Copy file name to clipboardExpand all lines: docs/api-js/enumerations/DeploymentStatus.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Enumeration: DeploymentStatus
8
8
9
-
Defined in: [enums/DeploymentStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L4)
9
+
Defined in: [enums/DeploymentStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L4)
10
10
11
11
Indicates the status of a deployment (after installing and restarting).
12
12
@@ -16,7 +16,7 @@ Indicates the status of a deployment (after installing and restarting).
16
16
17
17
> **FAILED**: `"DeploymentFailed"`
18
18
19
-
Defined in: [enums/DeploymentStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L8)
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
20
21
21
The deployment failed (and was rolled back).
22
22
@@ -26,6 +26,6 @@ The deployment failed (and was rolled back).
26
26
27
27
> **SUCCEEDED**: `"DeploymentSucceeded"`
28
28
29
-
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L13)
29
+
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L13)
Copy file name to clipboardExpand all lines: docs/api-js/enumerations/InstallMode.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Enumeration: InstallMode
8
8
9
-
Defined in: [enums/InstallMode.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L6)
9
+
Defined in: [enums/InstallMode.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L6)
10
10
11
11
Indicates when you would like an installed update to actually be applied.
12
12
@@ -16,7 +16,7 @@ Indicates when you would like an installed update to actually be applied.
16
16
17
17
> **IMMEDIATE**: `number`
18
18
19
-
Defined in: [enums/InstallMode.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L12)
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
20
21
21
Indicates that you want to install the update and restart the app immediately.
22
22
@@ -28,7 +28,7 @@ This value is appropriate for debugging scenarios as well as when displaying an
28
28
29
29
> **ON_NEXT_RESTART**: `number`
30
30
31
-
Defined in: [enums/InstallMode.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L19)
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
32
33
33
Indicates that you want to install the update, but not forcibly restart the app.
34
34
@@ -40,7 +40,7 @@ When the app is "naturally" restarted (due the OS or end user killing it), the u
40
40
41
41
> **ON_NEXT_RESUME**: `number`
42
42
43
-
Defined in: [enums/InstallMode.enum.ts:27](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L27)
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
44
45
45
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
46
@@ -53,7 +53,7 @@ This value is appropriate for silent installs that can be applied on resume in a
53
53
54
54
> **ON_NEXT_SUSPEND**: `number`
55
55
56
-
Defined in: [enums/InstallMode.enum.ts:34](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L34)
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
57
58
58
Indicates that you want to install the update when the app is in the background,
59
59
but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
Copy file name to clipboardExpand all lines: docs/api-js/enumerations/SyncStatus.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Enumeration: SyncStatus
8
8
9
-
Defined in: [enums/SyncStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L4)
9
+
Defined in: [enums/SyncStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L4)
10
10
11
11
Indicates the current status of a sync operation.
12
12
@@ -16,7 +16,7 @@ Indicates the current status of a sync operation.
16
16
17
17
> **AWAITING_USER_ACTION**: `6`
18
18
19
-
Defined in: [enums/SyncStatus.enum.ts:42](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L42)
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
20
21
21
An update is available, and a confirmation dialog was shown
22
22
to the end user. (This is only applicable when the `updateDialog` is used)
@@ -27,7 +27,7 @@ to the end user. (This is only applicable when the `updateDialog` is used)
27
27
28
28
> **CHECKING_FOR_UPDATE**: `5`
29
29
30
-
Defined in: [enums/SyncStatus.enum.ts:36](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L36)
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
31
32
32
The CodePush server is being queried for an update.
33
33
@@ -37,7 +37,7 @@ The CodePush server is being queried for an update.
37
37
38
38
> **DOWNLOADING_PACKAGE**: `7`
39
39
40
-
Defined in: [enums/SyncStatus.enum.ts:47](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L47)
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
41
42
42
An available update is being downloaded from the CodePush server.
43
43
@@ -47,7 +47,7 @@ An available update is being downloaded from the CodePush server.
47
47
48
48
> **INSTALLING_UPDATE**: `8`
49
49
50
-
Defined in: [enums/SyncStatus.enum.ts:52](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L52)
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
51
52
52
An available update was downloaded and is about to be installed.
53
53
@@ -57,7 +57,7 @@ An available update was downloaded and is about to be installed.
57
57
58
58
> **SYNC_IN_PROGRESS**: `4`
59
59
60
-
Defined in: [enums/SyncStatus.enum.ts:31](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L31)
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
61
62
62
There is an ongoing `sync` operation running which prevents the current call from being executed.
63
63
@@ -67,7 +67,7 @@ There is an ongoing `sync` operation running which prevents the current call fro
67
67
68
68
> **UNKNOWN_ERROR**: `3`
69
69
70
-
Defined in: [enums/SyncStatus.enum.ts:26](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L26)
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
71
72
72
The `sync` operation encountered an unknown error.
73
73
@@ -77,7 +77,7 @@ The `sync` operation encountered an unknown error.
77
77
78
78
> **UP_TO_DATE**: `0`
79
79
80
-
Defined in: [enums/SyncStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L8)
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
81
82
82
The app is fully up-to-date with the configured release channel.
83
83
@@ -87,7 +87,7 @@ The app is fully up-to-date with the configured release channel.
87
87
88
88
> **UPDATE_IGNORED**: `2`
89
89
90
-
Defined in: [enums/SyncStatus.enum.ts:21](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L21)
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
91
92
92
The app had an optional update which the end user chose to ignore.
93
93
(This is only applicable when the `updateDialog` is used)
@@ -98,7 +98,7 @@ The app had an optional update which the end user chose to ignore.
98
98
99
99
> **UPDATE_INSTALLED**: `1`
100
100
101
-
Defined in: [enums/SyncStatus.enum.ts:15](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L15)
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
102
103
103
An available update has been installed and will be run either immediately after the
104
104
`syncStatusChangedCallback` function returns or the next time the app resumes/restarts,
Copy file name to clipboardExpand all lines: docs/api-js/enumerations/UpdateState.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Enumeration: UpdateState
8
8
9
-
Defined in: [enums/UpdateState.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L6)
9
+
Defined in: [enums/UpdateState.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L6)
10
10
11
11
Indicates the state that an update is currently in.
12
12
@@ -16,7 +16,7 @@ Indicates the state that an update is currently in.
16
16
17
17
> **LATEST**: `number`
18
18
19
-
Defined in: [enums/UpdateState.enum.ts:24](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L24)
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
20
21
21
Indicates than an update represents the latest available release, and can be either currently running or pending.
22
22
@@ -26,7 +26,7 @@ Indicates than an update represents the latest available release, and can be eit
26
26
27
27
> **PENDING**: `number`
28
28
29
-
Defined in: [enums/UpdateState.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L19)
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
30
31
31
Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it.
32
32
@@ -38,7 +38,7 @@ This can be useful for determining whether there is a pending update, which you
38
38
39
39
> **RUNNING**: `number`
40
40
41
-
Defined in: [enums/UpdateState.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L12)
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
42
43
43
Indicates that an update represents the version of the app that is currently running.
Copy file name to clipboardExpand all lines: docs/api-js/functions/allowRestart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
> **allowRestart**(): `void`
10
10
11
-
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/allowRestart.ts#L8)
11
+
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/allowRestart.ts#L8)
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/checkForUpdates.ts#L18)
11
+
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/checkForUpdates.ts#L18)
12
12
13
13
Asks the CodePush service whether the configured app release channel has an update available.
Copy file name to clipboardExpand all lines: docs/api-js/functions/clearUpdates.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
> **clearUpdates**(): `void`
10
10
11
-
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/clearUpdates.ts#L10)
11
+
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/clearUpdates.ts#L10)
Copy file name to clipboardExpand all lines: docs/api-js/functions/disallowRestart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
> **disallowRestart**(): `void`
10
10
11
-
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/disallowRestart.ts#L8)
11
+
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/disallowRestart.ts#L8)
Copy file name to clipboardExpand all lines: docs/api-js/functions/getClientUniqueId.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
> **getClientUniqueId**(): `Promise`\<`string`\>
10
10
11
-
Defined in: [getClientUniqueId.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/getClientUniqueId.ts#L6)
11
+
Defined in: [getClientUniqueId.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/getClientUniqueId.ts#L6)
12
12
13
13
Gets the client's unique ID set by the module. You may also see `resetClientUniqueId`.
0 commit comments