Skip to content

Commit 25a2049

Browse files
committed
Bump version
1 parent ffaaf7f commit 25a2049

32 files changed

+35
-265
lines changed

Diff for: docs/api-js/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**@appzung/react-native-code-push**
1+
**@appzung/react-native-code-push v11.0.0-rc3**
22

33
---
44

5-
# @appzung/react-native-code-push
5+
# @appzung/react-native-code-push v11.0.0-rc3
66

77
## Enumerations
88

Diff for: docs/api-js/enumerations/CheckFrequency.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

55
[@appzung/react-native-code-push](../README.md) / CheckFrequency
66

77
# Enumeration: CheckFrequency
88

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-
119
Indicates when you would like to check for (and install) updates from the CodePush server.
1210

1311
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates when you would like to check for (and install) updates from the CodePu
1614

1715
> **MANUAL**: `2`
1816
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-
2117
Don't automatically check for updates, but only do it when `sync()` is manually called in app code.
2218

2319
---
@@ -26,8 +22,6 @@ Don't automatically check for updates, but only do it when `sync()` is manually
2622

2723
> **ON_APP_RESUME**: `1`
2824
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-
3125
When the app re-enters the foreground after being "backgrounded" (user pressed the home button, app launches a separate payment process, etc.)
3226

3327
---
@@ -36,6 +30,4 @@ When the app re-enters the foreground after being "backgrounded" (user pressed t
3630

3731
> **ON_APP_START**: `0`
3832
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-
4133
When the app is fully initialized (or more specifically, when the root component is mounted).

Diff for: docs/api-js/enumerations/DeploymentStatus.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

55
[@appzung/react-native-code-push](../README.md) / DeploymentStatus
66

77
# Enumeration: DeploymentStatus
88

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-
119
Indicates the status of a deployment (after installing and restarting).
1210

1311
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the status of a deployment (after installing and restarting).
1614

1715
> **FAILED**: `"DeploymentFailed"`
1816
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-
2117
The deployment failed (and was rolled back).
2218

2319
---
@@ -26,6 +22,4 @@ The deployment failed (and was rolled back).
2622

2723
> **SUCCEEDED**: `"DeploymentSucceeded"`
2824
29-
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L13)
30-
3125
The deployment succeeded.

Diff for: docs/api-js/enumerations/InstallMode.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

55
[@appzung/react-native-code-push](../README.md) / InstallMode
66

77
# Enumeration: InstallMode
88

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-
119
Indicates when you would like an installed update to actually be applied.
1210

1311
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates when you would like an installed update to actually be applied.
1614

1715
> **IMMEDIATE**: `number`
1816
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-
2117
Indicates that you want to install the update and restart the app immediately.
2218

2319
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
2824

2925
> **ON_NEXT_RESTART**: `number`
3026
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-
3327
Indicates that you want to install the update, but not forcibly restart the app.
3428

3529
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
4034

4135
> **ON_NEXT_RESUME**: `number`
4236
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-
4537
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.
4638

4739
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
5345

5446
> **ON_NEXT_SUSPEND**: `number`
5547
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-
5848
Indicates that you want to install the update when the app is in the background,
5949
but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
6050
so that user context isn't lost unless the app suspension is long enough to not matter.

Diff for: docs/api-js/enumerations/SyncStatus.md

+1-21
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

55
[@appzung/react-native-code-push](../README.md) / SyncStatus
66

77
# Enumeration: SyncStatus
88

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-
119
Indicates the current status of a sync operation.
1210

1311
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the current status of a sync operation.
1614

1715
> **AWAITING_USER_ACTION**: `6`
1816
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-
2117
An update is available, and a confirmation dialog was shown
2218
to the end user. (This is only applicable when the `updateDialog` is used)
2319

@@ -27,8 +23,6 @@ to the end user. (This is only applicable when the `updateDialog` is used)
2723

2824
> **CHECKING_FOR_UPDATE**: `5`
2925
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-
3226
The CodePush server is being queried for an update.
3327

3428
---
@@ -37,8 +31,6 @@ The CodePush server is being queried for an update.
3731

3832
> **DOWNLOADING_PACKAGE**: `7`
3933
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-
4234
An available update is being downloaded from the CodePush server.
4335

4436
---
@@ -47,8 +39,6 @@ An available update is being downloaded from the CodePush server.
4739

4840
> **INSTALLING_UPDATE**: `8`
4941
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-
5242
An available update was downloaded and is about to be installed.
5343

5444
---
@@ -57,8 +47,6 @@ An available update was downloaded and is about to be installed.
5747

5848
> **SYNC_IN_PROGRESS**: `4`
5949
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-
6250
There is an ongoing `sync` operation running which prevents the current call from being executed.
6351

6452
---
@@ -67,8 +55,6 @@ There is an ongoing `sync` operation running which prevents the current call fro
6755

6856
> **UNKNOWN_ERROR**: `3`
6957
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-
7258
The `sync` operation encountered an unknown error.
7359

7460
---
@@ -77,8 +63,6 @@ The `sync` operation encountered an unknown error.
7763

7864
> **UP_TO_DATE**: `0`
7965
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-
8266
The app is fully up-to-date with the configured release channel.
8367

8468
---
@@ -87,8 +71,6 @@ The app is fully up-to-date with the configured release channel.
8771

8872
> **UPDATE_IGNORED**: `2`
8973
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-
9274
The app had an optional update which the end user chose to ignore.
9375
(This is only applicable when the `updateDialog` is used)
9476

@@ -98,8 +80,6 @@ The app had an optional update which the end user chose to ignore.
9880

9981
> **UPDATE_INSTALLED**: `1`
10082
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-
10383
An available update has been installed and will be run either immediately after the
10484
`syncStatusChangedCallback` function returns or the next time the app resumes/restarts,
10585
depending on the `InstallMode` specified in `SyncOptions`

Diff for: docs/api-js/enumerations/UpdateState.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

55
[@appzung/react-native-code-push](../README.md) / UpdateState
66

77
# Enumeration: UpdateState
88

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-
119
Indicates the state that an update is currently in.
1210

1311
## Enumeration Members
@@ -16,8 +14,6 @@ Indicates the state that an update is currently in.
1614

1715
> **LATEST**: `number`
1816
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-
2117
Indicates than an update represents the latest available release, and can be either currently running or pending.
2218

2319
---
@@ -26,8 +22,6 @@ Indicates than an update represents the latest available release, and can be eit
2622

2723
> **PENDING**: `number`
2824
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-
3125
Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it.
3226

3327
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
3832

3933
> **RUNNING**: `number`
4034
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-
4335
Indicates that an update represents the version of the app that is currently running.
4436

4537
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.

Diff for: docs/api-js/functions/allowRestart.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **allowRestart**(): `void`
1010
11-
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/allowRestart.ts#L8)
12-
1311
Allow CodePush to restart the app.
1412

1513
This is an advanced API and is only necessary if your app explicitly disallowed restarts via the `disallowRestart` method.

Diff for: docs/api-js/functions/checkForUpdate.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **checkForUpdate**(`releaseChannelPublicId`?, `handleBinaryVersionMismatchCallback`?): `Promise`\<`null` \| [`RemotePackage`](../interfaces/RemotePackage.md)\>
1010
11-
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/checkForUpdates.ts#L18)
12-
1311
Asks the CodePush service whether the configured app release channel has an update available.
1412

1513
## Parameters

Diff for: docs/api-js/functions/clearUpdates.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **clearUpdates**(): `void`
1010
11-
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/clearUpdates.ts#L10)
12-
1311
Clears all downloaded CodePush updates.
1412

1513
This is useful when switching to a different release channel which may have an older release than the current package.

Diff for: docs/api-js/functions/disallowRestart.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **disallowRestart**(): `void`
1010
11-
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/disallowRestart.ts#L8)
12-
1311
Forbid CodePush to restart the app.
1412

1513
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.

Diff for: docs/api-js/functions/getClientUniqueId.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **getClientUniqueId**(): `Promise`\<`string`\>
1010
11-
Defined in: [getClientUniqueId.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/getClientUniqueId.ts#L6)
12-
1311
Gets the client's unique ID set by the module. You may also see `resetClientUniqueId`.
1412

1513
## Returns

Diff for: docs/api-js/functions/getUpdateMetadata.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **getUpdateMetadata**(`updateState`?): `Promise`\<`null` \| [`LocalPackage`](../interfaces/LocalPackage.md)\>
1010
11-
Defined in: [getUpdateMetadata.ts:11](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/getUpdateMetadata.ts#L11)
12-
1311
Retrieves the metadata for an installed update (e.g. description, mandatory).
1412

1513
## Parameters

Diff for: docs/api-js/functions/notifyAppReady.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **notifyAppReady**(): `Promise`\<`void` \| [`StatusReport`](../interfaces/StatusReport.md)\>
1010
11-
Defined in: [notifyAppReady.ts:19](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/notifyAppReady.ts#L19)
12-
1311
Notifies the CodePush runtime that an installed update is considered successful.
1412

1513
If you are manually checking for and installing updates (i.e. not using the `sync` method to handle it all for you), then this method **MUST** be called; otherwise CodePush will treat the update as failed and rollback to the previous version when the app next restarts.

Diff for: docs/api-js/functions/resetClientUniqueId.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@appzung/react-native-code-push**](../README.md)
1+
[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
22

33
---
44

@@ -8,8 +8,6 @@
88

99
> **resetClientUniqueId**(): `Promise`\<`string`\>
1010
11-
Defined in: [resetClientUniqueId.ts:7](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/resetClientUniqueId.ts#L7)
12-
1311
Resets the client's unique ID. You may use this in some GDPR compliance scenarios. Note that this will create a new MAU if a new request is sent later.
1412

1513
## Returns

0 commit comments

Comments
 (0)