PackageInstallerSession (sdk 1.27 API)

java.lang.Object
- com.datalogic.device.app.PackageInstallerSession

All Implemented Interfaces:

android.content.ServiceConnection
```
public class PackageInstallerSession
extends java.lang.Object
implements android.content.ServiceConnection
```
PackageInstallerSession gives developers the ability to group the execution of a sequence of install, uninstall and upgrade commands. Once the session is created, the commands install, uninstall, upgrade must be called inside a transaction. A transaction is opened calling openSession() and closed and commited calling closeSession().
To install two applications using a session do the following steps:
1. Obtain an instance of PackageInstaller with PackageInstaller.PackageInstaller(android.content.Context).
2. Obtain an instance of PackageInstallerListener that will be used to handle the result of the commands invoked on the session.
3. Create a PackageInstallerSession calling PackageInstaller.createSession(com.datalogic.device.app.PackageInstallerListener). The PackageInstaller.createSession(com.datalogic.device.app.PackageInstallerListener) method takes as parameters the instance of PackageInstallerListener created at the previous step.
4. Start a session calling openSession().
5. Call install(java.lang.String, boolean) to install the first application.
6. Call install(java.lang.String, boolean) to install the second application.
7. Close and commit the session calling closeSession().
8. The method onResult of the listener will be called when the execution of all the commands of the transaction are completed, either with success or failure. It contains the result of each command.

Constructor Summary

Constructors
Constructor and Description

PackageInstallerSession()

Constructors
Constructor and Description
`PackageInstallerSession()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`closeSession()` Call this method to execute the commands queued in the session.
`int`	`install(java.util.ArrayList<java.lang.String> apks, boolean atomic)` Call this method to install the applications contained within the .apk files specified by apks.
`int`	`install(java.lang.String apk, boolean force)` Call this method to install the application contained within the .apk file specified by apk.
`void`	`onServiceConnected(android.content.ComponentName className, android.os.IBinder binder)` Callback implemented to receive the asynchronous result of the bindService request.
`void`	`onServiceDisconnected(android.content.ComponentName className)` Callback implemented to receive the notify that the bind to the service is lost due to a crash of the service.
`int`	`openSession()` Call this method to start a session.
`int`	`uninstall(java.lang.String packageName)` Call this method to unistall an application installed on the device.
`int`	`upgrade(java.lang.String apk)` Call this method to upgrade an application installed on the device.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.content.ServiceConnection
onBindingDied, onNullBinding

- Constructor Detail
  - PackageInstallerSession
```
public PackageInstallerSession()
```
- Method Detail
  - openSession
```
public int openSession()
```
    Call this method to start a session.
    After this method, call the commands install, uninstall, upgrade to be executed.
    The commands will be queued and executed only when the closeSession() method is called.
    The commands will be executed in best effort.
    The results of each command will be delivered in a unique ordered list through the PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>) method.
    
    Returns:
    
    int PackageInstallerException.SUCCESS in case of success, otherwise a possible error code, matching one of the PackageInstallerException error constants.
    
    Throws:
    
    PackageInstallerException - in case of error, when exceptions are enabled through the ErrorManager singleton.
  - closeSession
```
public int closeSession()
```
    Call this method to execute the commands queued in the session.
    The commands will be executed in best effort.
    The command execution is asynchronous. The results of each command will be delivered in a unique ordered list through the listener PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>) method. Do not suspend the UIThread while waiting for the result of the method otherwise an application’s deadlock can occur.
  - onServiceConnected
```
public void onServiceConnected(android.content.ComponentName className,
                               android.os.IBinder binder)
```
    Callback implemented to receive the asynchronous result of the bindService request.
    
    Specified by:
    
    onServiceConnected in interface android.content.ServiceConnection
  - onServiceDisconnected
```
public void onServiceDisconnected(android.content.ComponentName className)
```
    Callback implemented to receive the notify that the bind to the service is lost due to a crash of the service.
    
    Specified by:
    
    onServiceDisconnected in interface android.content.ServiceConnection
  - install
```
public int install(java.lang.String apk,
                   boolean force)
```
    Call this method to install the application contained within the .apk file specified by apk.
    The method must be called after having called the openSession().
    The method is queued internally and executed only when the closeSession() is called.
    The result of the command is received through the listener method PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>).
    
    Example:
    
    PackageInstaller packageInstaller = new PackageInstaller(context);
    PackageInstallerListener listener = new PackageInstallerListener{public void onResult(List results) {...}};
    PackageInstallerSession session = packageInstaller.createSession(listener);
    session.openSession();
    session.install("/dir1/dir11/dir116/pkg1.apk", force);
    session.closeSession();
    
    Parameters:
    
    apk - String full path of the .apk to be installed.
    
    force - boolean true force the upgrade in case the application is already installed, otherwise the upgrade is refused.
    
    Returns:
    
    int PackageInstallerException.SUCCESS in case of success, otherwise a possible error code, matching one of the PackageInstallerException error constants.
    
    Throws:
    
    PackageInstallerException - in case of error, when exceptions are enabled through the ErrorManager singleton.
  - install
```
public int install(java.util.ArrayList<java.lang.String> apks,
                   boolean atomic)
```
    Call this method to install the applications contained within the .apk files specified by apks.
    It allows also the installation of an app distributed as multiple split APKs. Only in this case set atomic = true.
    The method must be called after having called the openSession().
    The method is queued internally and executed when the closeSession() is called.
    The result of the command is received through the listener method PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>).
    
    Example:
    public int install(ArrayList pkgs, boolean atomic)
    PackageInstaller packageInstaller = new PackageInstaller(context);
    PackageInstallerListener listener = new PackageInstallerListener{public void onResult(List results) {...}};
    PackageInstallerSession session = packageInstaller.createSession(listener);
    session.openSession();
    ArrayList apks = new ArrayList();
    apks.add("/dir1/dir11/dir116/pkg1.apk");
    apks.add("/dir1/dir11/dir116/pkg2.apk");
    session.install(apks, false);
    session.closeSession();
    
    Parameters:
    
    apks - ArrayList list of the full path of the .apk files to be installed.
    
    atomic - boolean true if "apks" lists the multiple split APKs of the application to be installed.
    
    Returns:
    
    int PackageInstallerException.SUCCESS in case of success, otherwise a possible error code, matching one of the PackageInstallerException error constants.
    
    Throws:
    
    PackageInstallerException - in case of error, when exceptions are enabled through the ErrorManager singleton.
  - upgrade
```
public int upgrade(java.lang.String apk)
```
    Call this method to upgrade an application installed on the device.
    The method must be called after having called the openSession().
    The method is queued internally and executed when the closeSession() is called.
    The result of the command is received through the listener method PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>).
    
    Example:
    
    PackageInstaller packageInstaller = new PackageInstaller(context);
    PackageInstallerListener listener = new PackageInstallerListener{public void onResult(List results) {...}};
    PackageInstallerSession session = packageInstaller.createSession(listener);
    session.openSession();
    session.upgrade("/dir1/dir11/dir116/pkg1_v2.apk");
    session.closeSession();
    
    Parameters:
    
    apk - String full path of the .apk to be used to upgrade the application already installed with the same Package Name of this .apk.
    
    Returns:
    
    int PackageInstallerException.SUCCESS in case of success, otherwise a possible error code, matching one of the PackageInstallerException error constants.
    
    Throws:
    
    PackageInstallerException - in case of error, when exceptions are enabled through the ErrorManager singleton.
  - uninstall
```
public int uninstall(java.lang.String packageName)
```
    Call this method to unistall an application installed on the device. The method must be called after having called the openSession().
    The method is queued internally and executed when the closeSession() is called.
    The result of the command is received through the listener method PackageInstallerListener.onResult(java.util.List<com.datalogic.device.app.PackageInstallerResult>).
    
    Example:
    
    PackageInstaller packageInstaller = new PackageInstaller(context);
    PackageInstallerListener listener = new PackageInstallerListener{public void onResult(List results) {...}};
    PackageInstallerSession session = packageInstaller.createSession(listener);
    session.openSession();
    session.uninstall("com.example.helloandroid");
    session.closeSession();
    
    Parameters:
    
    packageName - String package name of the application to be uninstalled.
    
    Returns:
    
    int PackageInstallerException.SUCCESS in case of success, otherwise a possible error code, matching one of the PackageInstallerException error constants.
    
    Throws:
    
    PackageInstallerException - in case of error, when exceptions are enabled through the ErrorManager singleton.

Class PackageInstallerSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface android.content.ServiceConnection

Constructor Detail

PackageInstallerSession

Method Detail

openSession

closeSession

onServiceConnected

onServiceDisconnected

install

install

upgrade

uninstall