| Modifier and Type | 87 |Constant Field | 88 |Value | 89 |
|---|---|---|
93 |
94 | public static final int |
95 | UPDATE_ERROR_START_APP_UPDATE_FLEXIBLE |
96 | 100 |
97 |
100 |
101 | public static final int |
102 | UPDATE_ERROR_START_APP_UPDATE_IMMEDIATE |
103 | 101 |
104 |
| Interface | 80 |Description | 81 |
|---|---|
| InAppUpdateManager.InAppUpdateHandler | 85 |
86 | Callback methods where update events are reported.
87 | |
88 |
| Class | 97 |Description | 98 |
|---|---|
| Constants | 102 |103 | |
| InAppUpdateManager | 106 |
107 | A simple implementation of the Android In-App Update API.
108 | |
109 |
| InAppUpdateStatus | 112 |
113 | This class is just a wrapper for AppUpdateInfo and InstallState
114 | Used by InAppUpdateManager
115 | |
116 |
| Enum | 125 |Description | 126 |
|---|---|
| Constants.UpdateMode | 130 |131 | |
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
79 |Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
91 |Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
111 |Each annotation type has its own separate page with the following sections:
115 |Each enum has its own separate page with the following sections:
126 |There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
144 |The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
148 |These links take you to the next or previous class, interface, package, or related page.
152 |These links show and hide the HTML frames. All pages are available with or without frames.
156 |The All Classes link shows all classes and interfaces except non-static nested types.
160 |Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
164 |The Constant Field Values page lists the static final fields and their values.
168 |
42 | * With default user confirmation, the InAppUpdateManager is monitoring the flexible update state, provide a default SnackBar that informs the user that installation is ready and requests user confirmation to restart the app.
43 | ```java
44 | @Override
45 | protected void onCreate(Bundle savedInstanceState) {
46 | super.onCreate(savedInstanceState);
47 | setContentView(R.layout.activity_main);
48 |
49 | InAppUpdateManager inAppUpdateManager = InAppUpdateManager.Builder(this, REQ_CODE_VERSION_UPDATE)
50 | .resumeUpdates(true) // Resume the update, if the update was stalled. Default is true
51 | .mode(UpdateMode.FLEXIBLE)
52 | .snackBarMessage("An update has just been downloaded.")
53 | .snackBarAction("RESTART")
54 | .handler(this);
55 |
56 | inAppUpdateManager.checkForAppUpdate();
57 | }
58 | ```
59 |
60 | * With custom user confirmation, need to set the `useCustomNotification(true)` and monitor the update for the `UpdateStatus.DOWNLOADED` status.
61 | Then a notification (or some other UI indication) can be used, to inform the user that installation is ready and requests user confirmation to restart the app. The confirmation must call the `completeUpdate()` method to finish the update.
62 | ```java
63 | public class FlexibleWithCustomNotification extends AppCompatActivity implements InAppUpdateManager.InAppUpdateHandler {
64 | private static final int REQ_CODE_VERSION_UPDATE = 530;
65 | private static final String TAG = "Sample";
66 | private InAppUpdateManager inAppUpdateManager;
67 |
68 | @Override
69 | protected void onCreate(Bundle savedInstanceState) {
70 | super.onCreate(savedInstanceState);
71 | setContentView(R.layout.activity_main);
72 |
73 | inAppUpdateManager = InAppUpdateManager.Builder(this, REQ_CODE_VERSION_UPDATE)
74 | .resumeUpdates(true) // Resume the update, if the update was stalled. Default is true
75 | .mode(UpdateMode.FLEXIBLE)
76 | // default is false. If is set to true you,
77 | // have to manage the user confirmation when
78 | // you detect the InstallStatus.DOWNLOADED status,
79 | .useCustomNotification(true)
80 | .handler(this);
81 |
82 | inAppUpdateManager.checkForAppUpdate();
83 | }
84 |
85 | // InAppUpdateHandler implementation
86 |
87 | @Override
88 | public void onInAppUpdateStatus(InAppUpdateStatus status) {
89 | /*
90 | * If the update downloaded, ask user confirmation and complete the update
91 | */
92 |
93 | if (status.isDownloaded()) {
94 |
95 | View rootView = getWindow().getDecorView().findViewById(android.R.id.content);
96 |
97 | Snackbar snackbar = Snackbar.make(rootView,
98 | "An update has just been downloaded.",
99 | Snackbar.LENGTH_INDEFINITE);
100 |
101 | snackbar.setAction("RESTART", view -> {
102 |
103 | // Triggers the completion of the update of the app for the flexible flow.
104 | inAppUpdateManager.completeUpdate();
105 |
106 | });
107 |
108 | snackbar.show();
109 |
110 | }
111 | }
112 | }
113 | ```
114 |
115 | ## Immediate
116 |
117 | 
118 |
119 | To perform an Immediate update, need only to set the mode to `IMMEDIATE` and call the `checkForAppUpdate()` method.
120 | ```java
121 | InAppUpdateManager.Builder(this, REQ_CODE_VERSION_UPDATE)
122 | .resumeUpdates(true) // Resume the update, if the update was stalled. Default is true
123 | .mode(UpdateMode.IMMEDIATE)
124 | .checkForAppUpdate();
125 |
126 | ```
127 |
128 |
129 | ### Forced updates
130 | There are sometimes, that we need to force all users to get a critical update. With Immediate update mode we can achieve such a blocking update mechanism. We need to override `onActivityResult` to detect if the user cancelled the process since the immediate screen can be closed through the back button, and start the update process again.
131 |
132 | ```java
133 | @Override
134 | protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
135 | if (requestCode == REQ_CODE_VERSION_UPDATE) {
136 | if (resultCode == Activity.RESULT_CANCELED) {
137 | // If the update is cancelled by the user,
138 | // you can request to start the update again.
139 | inAppUpdateManager.checkForAppUpdate();
140 |
141 | Log.d(TAG, "Update flow failed! Result code: " + resultCode);
142 | }
143 | }
144 | super.onActivityResult(requestCode, resultCode, data);
145 | }
146 | ```
147 |
148 | **Note:** You can decide which update should be forced by using for example `Firebase Remote Config` or a `Configuration file hosted on your server`
149 |
150 | ## Troubleshoot
151 | - In-app updates works only with devices running Android 5.0 (API level 21) or higher.
152 | - Testing this won’t work on a debug build. You would need a release build signed with the same key you use to sign your app before uploading to the Play Store. It would be a good time to use the internal testing track.
153 | - In-app updates are available only to user accounts that own the app. So, make sure the account you’re using has downloaded your app from Google Play at least once before using the account to test in-app updates.
154 | - Because Google Play can only update an app to a higher version code, make sure the app you are testing as a lower version code than the update version code.
155 | - Make sure the account is eligible and the Google Play cache is up to date. To do so, while logged into the Google Play Store account on the test device, proceed as follows:
156 | 1. Make sure you completely [close the Google Play Store App](https://support.google.com/android/answer/9079646#close_apps).
157 | 2. Open the Google Play Store app and go to the **My Apps & Games** tab.
158 | 3. If the app you are testing doesn’t appear with an available update, check that you’ve properly [set up your testing tracks](https://support.google.com/googleplay/android-developer/answer/3131213?hl=en).
159 | ## License
160 |
161 | Copyright 2019 Dionysios Karatzas
162 |
163 | Licensed under the Apache License, Version 2.0 (the "License");
164 | you may not use this file except in compliance with the License.
165 | You may obtain a copy of the License at
166 |
167 | http://www.apache.org/licenses/LICENSE-2.0
168 |
169 | Unless required by applicable law or agreed to in writing, software
170 | distributed under the License is distributed on an "AS IS" BASIS,
171 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
172 | See the License for the specific language governing permissions and
173 | limitations under the License.
174 |
175 |
176 | ## Contributing
177 |
178 | 1. Fork it
179 | 2. Create your feature branch (`git checkout -b my-new-feature`)
180 | 3. Commit your changes (`git commit -am 'Add some feature'`)
181 | 4. Push to the branch (`git push origin my-new-feature`)
182 | 5. **Create New Pull Request**
183 |
--------------------------------------------------------------------------------
/docs/javadoc/eu/dkaratzas/android/inapp/update/InAppUpdateManager.InAppUpdateHandler.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | public static interface InAppUpdateManager.InAppUpdateHandler
107 | | Modifier and Type | 124 |Method and Description | 125 |
|---|---|
void |
128 | onInAppUpdateError(int code,
129 | java.lang.Throwable error)
130 | On update error.
131 | |
132 |
void |
135 | onInAppUpdateStatus(InAppUpdateStatus status)
136 | Monitoring the update state of the flexible downloads.
137 | |
138 |
void onInAppUpdateError(int code, 161 | java.lang.Throwable error)162 |
code - the codeerror - the errorvoid onInAppUpdateStatus(InAppUpdateStatus status)177 |
status - the statuspublic class Constants
105 | extends java.lang.Object
106 | | Modifier and Type | 122 |Class and Description | 123 |
|---|---|
static class |
126 | Constants.UpdateMode |
127 |
| Modifier and Type | 141 |Field and Description | 142 |
|---|---|
static int |
145 | UPDATE_ERROR_START_APP_UPDATE_FLEXIBLE |
146 |
static int |
149 | UPDATE_ERROR_START_APP_UPDATE_IMMEDIATE |
150 |
| Constructor and Description | 164 |
|---|
Constants() |
167 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final int UPDATE_ERROR_START_APP_UPDATE_FLEXIBLE205 |
public static final int UPDATE_ERROR_START_APP_UPDATE_IMMEDIATE218 |
public Constants()239 |
public class InAppUpdateStatus
111 | extends java.lang.Object
112 | | Constructor and Description | 130 |
|---|
InAppUpdateStatus() |
133 |
| Modifier and Type | 147 |Method and Description | 148 |
|---|---|
int |
151 | availableVersionCode() |
152 |
boolean |
155 | isDownloaded() |
156 |
boolean |
159 | isDownloading() |
160 |
boolean |
163 | isFailed() |
164 |
boolean |
167 | isUpdateAvailable() |
168 |
void |
171 | setAppUpdateInfo(AppUpdateInfo appUpdateInfo) |
172 |
void |
175 | setInstallState(InstallState installState) |
176 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic InAppUpdateStatus()206 |
public void setAppUpdateInfo(AppUpdateInfo appUpdateInfo)223 |
public void setInstallState(InstallState installState)232 |
public boolean isDownloading()241 |
public boolean isDownloaded()250 |
public boolean isFailed()259 |
public boolean isUpdateAvailable()268 |
public int availableVersionCode()277 |
public static enum Constants.UpdateMode 124 | extends java.lang.Enum<Constants.UpdateMode>125 |
| Enum Constant and Description | 141 |
|---|
FLEXIBLE |
144 |
IMMEDIATE |
147 |
| Modifier and Type | 161 |Method and Description | 162 |
|---|---|
static Constants.UpdateMode |
165 | valueOf(java.lang.String name)
166 | Returns the enum constant of this type with the specified name.
167 | |
168 |
static Constants.UpdateMode[] |
171 | values()
172 | Returns an array containing the constants of this enum type, in
173 | the order they are declared.
174 | |
175 |
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final Constants.UpdateMode FLEXIBLE212 |
public static final Constants.UpdateMode IMMEDIATE221 |
public static Constants.UpdateMode[] values()238 |
242 | for (Constants.UpdateMode c : Constants.UpdateMode.values()) 243 | System.out.println(c); 244 |
public static Constants.UpdateMode valueOf(java.lang.String name)258 |
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null45 | *
For more information about In-App Updates you can check the official 48 | * documentation 49 | *
50 | *