Open topic with navigation

com.hp.lft.sdk.mobile

## Class DeviceSessionOptions

- java.lang.Object
- - com.hp.lft.sdk.mobile.DeviceSessionOptions

-     public class DeviceSessionOptions
      extends java.lang.Object

  Defines the options that will be used during the device session.

- - ### Constructor Summary

    Constructor and Description
    `DeviceSessionOptions()` Creates a new instance of `DeviceSessionOptions`.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `ApplicationDescription[]` | `getAppsToInstall()` Returns the `ApplicationDescription` array representing additional applications to install.
    `DeviceVitalsCollectOptions` | `getCollectVitals()` Returns the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.
    `DeviceSource` | `getDeviceSource()` Returns a `DeviceSource` representing the source of the device to use.
    `boolean` | `isCollectLogs()` Indicates whether logs should be collected in this session.
    `boolean` | `isEnableServiceVirtualization()` Indicates whether Service Virtualization is enabled in this session. Supported in LeanFT versions 14.51 and later.
    `DeviceSessionOptions` | `setAppsToInstall(ApplicationDescription[] appsToInstall)` Sets the `ApplicationDescription` array representing additional applications to install.
    `DeviceSessionOptions` | `setCollectLogs(boolean collectLogs)` Sets whether logs should be collected in this session.
    `DeviceSessionOptions` | `setCollectVitals(DeviceVitalsCollectOptions collectVitals)` Sets the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.
    `DeviceSessionOptions` | `setDeviceSource(DeviceSource deviceSource)` Sets the `DeviceSource` representing the source of the device to use.
    `DeviceSessionOptions` | `setEnableServiceVirtualization(boolean enableServiceVirtualization)` Sets whether Service Virtualization should be enabled in this session. Supported in LeanFT versions 14.51 and later.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### DeviceSessionOptions

          public DeviceSessionOptions()

      Creates a new instance of `DeviceSessionOptions`. Note: the default value for collectLogs is true.

  - ### Method Detail

    - #### getAppsToInstall

          public ApplicationDescription[] getAppsToInstall()

      Returns the `ApplicationDescription` array representing additional applications to install.
      Returns:
        the `ApplicationDescription` array representing additional applications to install.

    - #### setAppsToInstall

          public DeviceSessionOptions setAppsToInstall(ApplicationDescription[] appsToInstall)

      Sets the `ApplicationDescription` array representing additional applications to install.
      Parameters:
        `appsToInstall` - the `ApplicationDescription` array representing additional applications to install.
      Returns:
        the `DeviceSessionOptions` instance with the updated state (builder pattern).

    - #### getDeviceSource

          public DeviceSource getDeviceSource()

      Returns a `DeviceSource` representing the source of the device to use.
      Returns:
        a `DeviceSource` representing the source of the device to use.

    - #### setDeviceSource

          public DeviceSessionOptions setDeviceSource(DeviceSource deviceSource)

      Sets the `DeviceSource` representing the source of the device to use.
      Parameters:
        `deviceSource` - the `DeviceSource` representing the source of the device to use.
      Returns:
        the `DeviceSessionOptions` instance with the updated state (builder pattern).

    - #### isCollectLogs

          public boolean isCollectLogs()

      Indicates whether logs should be collected in this session. The default value for collectLogs is true.
      Returns:
        true if logs should be collected in this session.

    - #### isEnableServiceVirtualization

          public boolean isEnableServiceVirtualization()

      Indicates whether Service Virtualization is enabled in this session. The default value for enableServiceVirtualization is false.
      Supported in LeanFT versions 14.51 and later.
      Returns:
        true if Service Virtualization is enabled in this session.

    - #### setCollectLogs

          public DeviceSessionOptions setCollectLogs(boolean collectLogs)

      Sets whether logs should be collected in this session.
      Parameters:
        `collectLogs` - true if logs should be collected in this session.
      Returns:
        the `DeviceSessionOptions` instance with the updated state (builder pattern).

    - #### getCollectVitals

          public DeviceVitalsCollectOptions getCollectVitals()

      Returns the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.
      Returns:
        the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.

    - #### setCollectVitals

          public DeviceSessionOptions setCollectVitals(DeviceVitalsCollectOptions collectVitals)

      Sets the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.
      Parameters:
        `collectVitals` - the `DeviceVitalsCollectOptions` defining which device vitals should be collected in this session.
      Returns:
        the `DeviceSessionOptions` instance with the updated state (builder pattern).

    - #### setEnableServiceVirtualization

          public DeviceSessionOptions setEnableServiceVirtualization(boolean enableServiceVirtualization)

      Sets whether Service Virtualization should be enabled in this session. (By default it is not enabled)
      Supported in LeanFT versions 14.51 and later.
      Parameters:
        `enableServiceVirtualization` - true if Service Virtualization should be enabled in this session.
      Returns:
        the `DeviceSessionOptions` instance with the updated state (builder pattern).