Open topic with navigation

com.hp.lft.sdk.mobile

## Interface Application

- All Superinterfaces:
    TestObject, TestObjectDescriber

      public interface Application
      extends TestObject

  A mobile application.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getIdentifier()` Returns the application identifier string.
    `String` | `getName()` Returns the name of the mobile application.
    `int` | `getUpload()` Returns the application upload number.
    `String` | `getVersion()` Returns the application's version.
    `void` | `install()` Installs (or re-installs) the application and then launches it.
    `boolean` | `isPackaged()` Indicates whether the application is packaged (instrumented) or not.
    `void` | `kill()` Stops the application.
    `void` | `launch()` Launches the application if it is not started.
    `void` | `restart()` Launches the application if it is closed, or restarts the application if it is already running.
    `SimulateAuthResult` | `simulateAuthentication()` Returns an object used to define the result of simulating authentication for the application.
    `void` | `simulateBarcodeScan(String imageID)` Simulate barcode or QR code scan using an image file.
    `void` | `startCameraSimulationMode(String mediaID)` Start camera simulation mode.
    `void` | `stopCameraSimulationMode()` Stop camera simulation mode.
    `void` | `uninstall()` Uninstalls the application.

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

- - ### Method Detail

    - #### getIdentifier

          String getIdentifier()
                               throws GeneralLeanFtException

      Returns the application identifier string.
      Returns:
        the application identifier string.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution

    - #### getName

          String getName()
                         throws GeneralLeanFtException

      Returns the name of the mobile application.
      Returns:
        the name of the mobile application.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution

    - #### getVersion

          String getVersion()
                            throws GeneralLeanFtException

      Returns the application's version.
      Returns:
        the application's version.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isPackaged

          boolean isPackaged()
                             throws GeneralLeanFtException

      Indicates whether the application is packaged (instrumented) or not.
      Returns:
        true if this application is packaged (instrumented).
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getUpload

          int getUpload()
                        throws GeneralLeanFtException

      Returns the application upload number.
      Returns:
        the application upload number.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### launch

          void launch()
                      throws GeneralLeanFtException

      Launches the application if it is not started.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution

    - #### restart

          void restart()
                       throws GeneralLeanFtException

      Launches the application if it is closed, or restarts the application if it is already running.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution

    - #### install

          void install()
                       throws GeneralLeanFtException

      Installs (or re-installs) the application and then launches it.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution

    - #### kill

          void kill()
                    throws GeneralLeanFtException

      Stops the application.
      Throws:
        `GeneralLeanFtException`

    - #### uninstall

          void uninstall()
                         throws GeneralLeanFtException

      Uninstalls the application.
      Throws:
        `GeneralLeanFtException`

    - #### startCameraSimulationMode

          void startCameraSimulationMode(String mediaID)
                                         throws GeneralLeanFtException

      Start camera simulation mode. Run after Device.UploadMedia. Once simulation is completed, run StopCameraSimulationMode.
      Parameters:
        `mediaID` - the unique ID of the uploaded media to use in the simulation, as used in Device.UploadMedia.
      Throws:
        `GeneralLeanFtException`

    - #### stopCameraSimulationMode

          void stopCameraSimulationMode()
                                        throws GeneralLeanFtException

      Stop camera simulation mode.
      Throws:
        `GeneralLeanFtException`

    - #### simulateBarcodeScan

          void simulateBarcodeScan(String imageID)
                                   throws GeneralLeanFtException

      Simulate barcode or QR code scan using an image file. Run after Device.UploadMedia.
      Parameters:
        `imageID` - the unique ID of the uploaded image to use in the simulation as used in IDevice.UploadMedia.
      Throws:
        `GeneralLeanFtException`

    - #### simulateAuthentication

          SimulateAuthResult simulateAuthentication()

      Returns an object used to define the result of simulating authentication for the application.
      Returns:
        an object used to define the result of simulating authentication for the application.