Package com.hp.lft.sdk.mobile

Interface Device

All Superinterfaces:
Environment, TestObject, TestObjectDescriber
public interface Device extends TestObject, Environment
A mobile device.

  • Method Details

    • getId

      String getId() throws GeneralLeanFtException
      Returns the ID of the device in OpenText Functional Testing Lab.
      Returns:
      the ID of the device in OpenText Functional Testing Lab.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getModel

      String getModel() throws GeneralLeanFtException
      Returns the model name of the device.
      Returns:
      the model name of the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getManufacturer

      String getManufacturer() throws GeneralLeanFtException
      Returns the manufacturer of the device.
      Returns:
      the manufacturer of the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getOSType

      String getOSType() throws GeneralLeanFtException
      Returns the operating system currently running on the device.
      Returns:
      the operating system currently running on the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getOSVersion

      String getOSVersion() throws GeneralLeanFtException
      Returns the operating system version currently running on the device.
      Returns:
      the operating system version currently running on the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getName

      String getName() throws GeneralLeanFtException
      Returns name of the device as defined in OpenText Functional Testing Lab.
      Returns:
      the name of the device as defined in OpenText Functional Testing Lab.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getSource

      DeviceSource getSource() throws GeneralLeanFtException
      The source to take the device from
      Returns:
      the DeviceSource to take the device from
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getFleetType

      String getFleetType() throws GeneralLeanFtException
      Returns fleetType of the device as defined in OpenText Functional Testing Lab.
      Returns:
      the fleetType of the device as defined in OpenText Functional Testing Lab.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getLocation

      String getLocation() throws GeneralLeanFtException
      Returns location of the device as defined in OpenText Functional Testing Lab.
      Returns:
      the location of the device as defined in OpenText Functional Testing Lab.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • home

      void home() throws GeneralLeanFtException
      Presses the device's Home button (Android Only).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • back

      void back() throws GeneralLeanFtException
      Presses the device's Back button (Android Only).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • pan

      void pan(Point start, Point end) throws GeneralLeanFtException
      Performs a Pan gesture on the device.
      Parameters:
      start - the location at which to start the pan gesture.
      end - the location at which to end the pan gesture.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • pan

      void pan(Point start, Point end, PanArgs args) throws GeneralLeanFtException
      Performs a Pan gesture on the device.
      Parameters:
      start - the location at which to start the pan gesture.
      end - the location at which to end the pan gesture.
      args - additional arguments for the pan operation.
      Throws:
      GeneralLeanFtException - if error occurs during execution.

    • recentApps

      void recentApps() throws GeneralLeanFtException
      Opens the list of recent applications (Android Only).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setOrientation

      void setOrientation(DeviceOrientation orientation) throws GeneralLeanFtException
      Sets the device orientation.
      Parameters:
      orientation - the DeviceOrientation to set on the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • touch

      void touch(int x, int y) throws GeneralLeanFtException
      Touches the device at the specified coordinates (Android Only).
      Parameters:
      x - the x coordinate to touch.
      y - the y coordinate to touch.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • touch

      void touch(Point point) throws GeneralLeanFtException
      Touches the device at the specified point (Android Only).
      Parameters:
      point - the point to touch.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • swipe

      void swipe(SwipeDirection direction) throws GeneralLeanFtException
      Swipes the device in the specified direction starting from the leading edge of the element or device.
      Parameters:
      direction - the SwipeDirection.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • swipe

      void swipe(SwipeDirection direction, Location startLocation) throws GeneralLeanFtException
      Swipes the device in the specified direction starting from the specified location.
      Parameters:
      direction - the SwipeDirection.
      startLocation - the Location coordinates at which to start the swipe.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • simulateGPSRelocate

      void simulateGPSRelocate(double latitude, double longitude) throws GeneralLeanFtException
      Simulates a change in the device's GPS location (Android Only).
      Parameters:
      latitude - the latitude coordinate of the location.
      longitude - the longitude coordinate of the location.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • simulateIncomingCall

      void simulateIncomingCall(String from) throws GeneralLeanFtException
      Simulates an incoming call.
      Parameters:
      from - the caller ID of the incoming call.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • simulateIncomingCall

      void simulateIncomingCall(String from, EventResponseArgs eventResponseArgs) throws GeneralLeanFtException
      Simulates an incoming call with an optional simulated user response.
      Parameters:
      from - the caller ID of the incoming call.
      eventResponseArgs - the simulated user response EventResponseArgs to the incoming call that interrupts the flow of the application.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • simulateIncomingSMS

      void simulateIncomingSMS(String from, String text) throws GeneralLeanFtException
      Simulates an incoming SMS.
      Parameters:
      from - the caller ID of the incoming SMS message.
      text - the text of the incoming SMS message.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • simulateIncomingSMS

      void simulateIncomingSMS(String from, String text, EventResponseArgs eventResponseArgs) throws GeneralLeanFtException
      Simulates an incoming SMS with an optional simulated user response.
      Parameters:
      from - the caller ID of the incoming SMS message.
      text - the text of the incoming SMS message.
      eventResponseArgs - the simulated user response EventResponseArgs to the incoming SMS that interrupts the flow of the application.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • networkVirtualizationStart

      void networkVirtualizationStart(String profile) throws GeneralLeanFtException
      Starts the Network Virtualization service using the specified network profile.
      Parameters:
      profile - the name of the profile containing the conditions that you want to apply to the virtualized network. The profile must be set up on the Network Virtualization product.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • networkVirtualizationStop

      void networkVirtualizationStop() throws GeneralLeanFtException
      Stops the Network Virtualization service
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • shake

      void shake() throws GeneralLeanFtException
      Performs a Shake gesture on the device (iOS Only).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • openViewer

      void openViewer() throws GeneralLeanFtException
      Opens an RDP window for the device. If a window for the device is open already, another window will not open.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • closeViewer

      void closeViewer() throws GeneralLeanFtException
      Closes the RDP window for the device (if open). Calling this method does not release the device locking.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isViewerOpen

      boolean isViewerOpen() throws GeneralLeanFtException
      Checks if the RDP window for the device is open.
      Returns:
      true if the RDP window is open, false otherwise.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getLogs

      String getLogs() throws GeneralLeanFtException
      Returns the device logs collected from the moment the device was locked.
      Returns:
      the device logs collected from the moment the device was locked.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getVitals

      String getVitals() throws GeneralLeanFtException
      Returns an accumulation of the device vitals from the time the device was locked, in one second intervals.
      Returns:
      the device vitals collected since the device was locked.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • unlock

      void unlock() throws GeneralLeanFtException
      Unlocks the device in OpenText Functional Testing Lab if it is not locked by another device object. This method also closes the RDP window.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendString

      void sendString(String text) throws GeneralLeanFtException
      Simulates entering text (a string) using the device keyboard.
      Parameters:
      text - The text to send to the device.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendString

      void sendString(String text, int interval) throws GeneralLeanFtException
      Simulates entering text (a string) using the device keyboard, with the option to send each of the string characters in intervals of n milliseconds.
      Parameters:
      text - The text to send to the device.
      interval - The time (in milliseconds) to wait before injecting each subsequent character. The value must be between 200 and 3000, or 0 (default), otherwise an exception is thrown.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendKey

      void sendKey(Keys key) throws GeneralLeanFtException
      Simulates pressing a special key in the device keyboard.
      Parameters:
      key - The key to be pressed.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendKey

      void sendKey(Keys key, int duration) throws GeneralLeanFtException
      Simulates pressing a special key in the device keyboard, with the option to define the time to keep the key pressed.
      Parameters:
      key - The key to be pressed.
      duration - The time (in milliseconds) to keep the key pressed. The default is 0 (zero).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendKey

      void sendKey(String keyId) throws GeneralLeanFtException
      Simulates pressing a custom device key.
      Parameters:
      keyId - The ID of the key as defined by the device manufacturer.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • sendKey

      void sendKey(String keyId, int duration) throws GeneralLeanFtException
      Simulate pressing a custom device key, with the option to define the time to keep the key pressed.
      Parameters:
      keyId - the ID of the key as defined by the device manufacturer.
      duration - The time (in milliseconds) to keep the key pressed. The default is 0 (zero).
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(URL mediaUrl, String mediaID) throws GeneralLeanFtException
      Upload a media file to the device for camera or video simulation. The files are deleted when the device is released.
      Parameters:
      mediaUrl - The URL, including the extension, of the media file (image or video). Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only), MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded media. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(URL mediaUrl, String mediaID, MediaUploadOptions options) throws GeneralLeanFtException
      Upload a media file to the device for camera or video simulation, with the option to save the file. The files are deleted when the device is released.
      Parameters:
      mediaUrl - The URL, including the extension, of the media file (image or video). Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only), MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded media. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      options - Upload options.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(String mediaUrl, String mediaID) throws GeneralLeanFtException
      Upload a media file to the device for camera or video simulation. The files are deleted when the device is released.
      Parameters:
      mediaUrl - The URL, including the extension, of the media file (image or video). Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only), MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded media. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(String mediaUrl, String mediaID, MediaUploadOptions options) throws GeneralLeanFtException
      Upload a media file to the device for camera or video simulation, with the option to save the file. The files are deleted when the device is released.
      Parameters:
      mediaUrl - The URL, including the extension, of the media file (image or video). Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only), MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded media. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      options - Upload options.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(RenderedImage image, ImageFormat imageFormat, String mediaID) throws GeneralLeanFtException
      Upload an image to the device for camera simulation. The file is deleted when the device is released.
      Parameters:
      image - The image file.
      imageFormat - The image format type. Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only).
      mediaID - The unique ID of the uploaded media. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(RenderedImage image, ImageFormat imageFormat, String mediaID, MediaUploadOptions options) throws GeneralLeanFtException
      Upload an image to the device for camera simulation, with the option to save the file. The files are deleted when the device is released.
      Parameters:
      image - The image file.
      imageFormat - The image format type. Supported formats: JPG, GIF, PNG, BMP, TIF (iOS only).
      mediaID - The unique ID of the uploaded image. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      options - Upload options.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(VideoData videoData, String mediaID) throws GeneralLeanFtException
      Upload a video to the device for video simulation. The file is deleted when the device is released.
      Parameters:
      videoData - Video file data. Supported formats: MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded video. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • uploadMedia

      void uploadMedia(VideoData videoData, String mediaID, MediaUploadOptions options) throws GeneralLeanFtException
      Upload a video to the device for video simulation, with the option to save the file. The file is deleted when the device is released.
      Parameters:
      videoData - Video file data. Supported formats: MP4, 3GP (Android only), MKV (Android only), MOV (iOS only), M4V (iOS only).
      mediaID - The unique ID of the uploaded video. The ID is used to start the simulation using Application.StartCameraSimulationMode.
      options - Upload options.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • svUploadService

      String svUploadService(String serviceFileContents) throws GeneralLeanFtException
      Uploads a service definition file to the device and makes it available in the current session.
      Parameters:
      serviceFileContents - The contents of the service definition text file as a string.
      Returns:
      A string representing the ID of the uploaded service.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • svUploadScenario

      String svUploadScenario(String svServiceId, String scenarioFilesFolder) throws GeneralLeanFtException
      Uploads scenario definition files to the device and makes them available in the current session.
      Parameters:
      svServiceId - The ID of the relevant service, as returned by svUploadService
      scenarioFilesFolder - The full path to the folder that contains the scenario definition files.
      Returns:
      A string representing the ID of the uploaded scenario.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • svStartScenario

      void svStartScenario(String svScenarioId) throws GeneralLeanFtException
      Starts a specific service virtualization scenario.
      Parameters:
      svScenarioId - The ID of the relevant scenario, as returned by svUploadScenario
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • svStopScenario

      void svStopScenario(String svScenarioId) throws GeneralLeanFtException
      Stops a specific service virtualization scenario.
      Parameters:
      svScenarioId - The ID of the relevant scenario, as returned by svUploadScenario
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getSvInfo

      SvInfo getSvInfo() throws GeneralLeanFtException
      Returns Service Virtualization Server info
      Returns:
      Object of type SvInfo, containing Service Virtualization information
      Throws:
      GeneralLeanFtException - if error occurs during execution.