InstantAppsClient

public class InstantAppsClient extends GoogleApi<Api.ApiOptions.NoOptions>

Main entry point to APIs for Android instant apps.

Example use:

InstantAppsClient client = InstantApps.getInstantAppsClient(context);
 Task<ParcelFileDescriptor> fileTask = client.getInstantAppData();
 fileTask
     .addOnCompleteListener(fileTask -> readData(fileTask.getResult()))
     .addOnFailureListener(exception -> handleException(exception));

Inherited Field Summary

From class com.google.android.gms.common.api.GoogleApi

protected final GoogleApiManager zabm

Public Method Summary

Task<Boolean>	areInstantAppsEnabledForDevice() Checks whether this device satisfied all preconditions to run instant apps.
Task<ParcelFileDescriptor>	getInstantAppData() Retrieves a `ParcelFileDescriptor` to the caller's instant app's data.

Inherited Method Summary

From class com.google.android.gms.common.api.GoogleApi

GoogleApiClient	asGoogleApiClient()
ClientSettings.Builder	createClientSettingsBuilder()
Task<Boolean>	disconnectService()
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doBestEffortWrite(ApiMethodImpl arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doBestEffortWrite(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doRead(ApiMethodImpl arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doRead(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient> Task<Void>	doRegisterEventListener(RegistrationMethods arg0)
<A extends Api.AnyClient, T extends RegisterListenerMethod<A, ?>, U extends UnregisterListenerMethod<A, ?>> Task<Void>	doRegisterEventListener(RegisterListenerMethod arg0, UnregisterListenerMethod arg1)
Task<Boolean>	doUnregisterEventListener(ListenerKey arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doWrite(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doWrite(ApiMethodImpl arg0)
final Api<Api.ApiOptions.NoOptions>	getApi()
Api.ApiOptions.NoOptions	getApiOptions()
Context	getApplicationContext()
final int	getInstanceId()
Looper	getLooper()
<L> ListenerHolder<L>	registerListener(Object arg0, String arg1)
zace	zaa(Context arg0, Handler arg1)
Api.Client	zaa(Looper arg0, zaa<Api.ApiOptions.NoOptions> arg1)
final zai<Api.ApiOptions.NoOptions>	zak()

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public Task<Boolean> areInstantAppsEnabledForDevice ()

Checks whether this device satisfied all preconditions to run instant apps. Default is false.

public Task<ParcelFileDescriptor> getInstantAppData ()

Retrieves a ParcelFileDescriptor to the caller's instant app's data.

The file format is Zip, which is compatible with Android's native ZipOutputStream and ZipInputStream.

What is in the Zip file?

Shared preferences files.
Files in the directory returned by getFilesDir().
Files in the directory returned by getDatabasePath(String), which also includes files created with the SQLiteOpenHelper class.
Files in directories created with getDir(String, int).

Note: Since instant apps cannot access external storage, no information from external storage will be returned.

Files in directories returned by getCacheDir(), getCodeCacheDir(), or getNoBackupFilesDir() are excluded. The files saved in these locations are only needed temporarily, or are intentionally excluded from transfer operations.

Security Requirements:

You may only request data for your own package. The package name is implied from calling getPackageName() within your app.
You must sign your instant apps and your installed apps with the exact same key(s). i.e. If your instant app has two certificates, your Installed App must as well.