Description

A mobile device.

Operations

The sections below list the built-in methods and properties that you can use as operations for the Device object.

Note: You can also view a list and descriptions of the Device description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Back	Presses the device's Back button. (Android Only)
CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Check	Checks whether the actual value of an item matches the expected value.
CheckProperty	Checks whether the specified object property achieves the specified value within the specified timeout.
ChildObjects	Returns the collection of child objects contained within the object.
ClickOnText	Clicks the specified location on the device, relative to the recognized text string.
CloseViewer	Closes the Digital Lab remote access window.
EnterKeys	Uses the device’s keyboard to enter information.
GetAllROProperties	Returns the collection of properties and current values from the object in the application.
GetROProperty	Returns the current value of the specified description property from the object in the application.
GetTOProperties	Returns the collection of properties and values used to identify the object.
GetTOProperty	Returns the value of the specified description property from the test object description.
Highlight	Highlights the object in the application.
GPSRelocate	Simulates a change in the device's GPS location. (Android Only)
Home	Presses the device's Home button.
IncomingCall	Simulates an incoming call and optionally sends the app to the background for the specified number of seconds.
IncomingSMS	Simulates an incoming SMS and optionally sends the app to the background for the specified number of seconds.
MaximizeViewer	Maximizes the remote access window.
Menu	Presses the device's Menu button. (Android Only)
MediaFileExist	Checks if the file for sensor simulation exists on the Digital Lab server.
MinimizeViewer	Minimizes the remote access window.
OpenViewer	Opens the Digital Lab remote access window.
Output	Retrieves the current value of an item and stores it in a specified location.
Pan	Performs a Pan gesture on the object.
RecentApps	Opens the list of recent applications. (Android Only)
RefreshObject	Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object.
RestoreViewer	Restores the remote access window to its previous position and size.
SetOrientation	Sets the device orientation.
SetTOProperty	Sets the value of the specified description property in the test object description.
StartNV	Starts the Network Virtualization service using the specified network profile.
StopNV	Stops the Network Virtualization service.
Swipe	Swipes the device in the specified direction.
ToString	Returns a string that represents the current test object.
Touch	Touches the device at the specified coordinates. (Android Only)
Unlock	Unlocks the device.
UploadMedia	Uploads a file for sensor simulation to the Digital Lab server.
WaitProperty	Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Exist

Checks whether the device currently exists in the Mobile server.

Back to top

Back Method

Description

Presses the device's Back button. (Android Only)

Syntax

object.Back

Return Type

None

Back to top

ClickOnText Method

Description

Clicks the specified location on the device, relative to the recognized text string.

Syntax

object.ClickOnText Text, [index], [offsetX], [offsetY]

Arguments

Return Type

None

IMPORTANT

This method depends on OpenText Functional Testing's OCR mechanism. For details, see the section on Guidelines for Text Recognition in the OpenText Functional Testing Help Center.

Example

Click to the right of the second 'Switch' text string (VBScript)

                    'The following examples clicks to the right of the second instance of the recognized "Switch" string.
'In this example, the click point is determined by placing the "Switch" text string in the center of the bitmap.

Device("Device").ClickOnText "Switch",1,50,1

Back to top

CloseViewer Method

Description

Closes the Digital Lab remote access window.

Syntax

object.CloseViewer

Return Type

None

IMPORTANT

You can use this method together with the OpenViewer method to open and close the remote access window during a run session.

For example, if you run your tests silently (configured in Tools > Options > GUI Testing > Mobile / Digital Lab), you can open the remote access window to do the following:

- Run steps on Insight objects

- Perform bitmap checkpoints

- Record and run analog steps via OpenText Functional Testing (not relevant for analog steps via the Digital Lab Options panel).

Then you can close the window after the steps run to continue running the test silently.

For more details, see the Digital Lab Help.

Back to top

EnterKeys Method

Description

Uses the device’s keyboard to enter information.

Syntax

object.EnterKeys InputKeyType, value

Arguments

Back to top

GPSRelocate Method

Description

Simulates a change in the device's GPS location. (Android Only)

Syntax

object.GPSRelocate Latitude, Longitude

Arguments

Return Type

None

Example

Simulate setting the GPS Coordinates of a Device (VBScript)

'The following example simulates setting the GPS coordinates of a Device.

Device("Device").GPSRelocate 37.500000,-120.300000

Back to top

Home Method

Description

Presses the device's Home button.

Syntax

object.Home

Return Type

None

Back to top

IncomingCall Method

Description

Simulates an incoming call and optionally sends the app to the background for the specified number of seconds.

Syntax

object.IncomingCall From, [TimeInBackground], [RespondToEvent]

Arguments

Return Type

None

IMPORTANT

This method is supported only on packaged apps.

Example

Simulate Receiving an Incoming Phone Call (VBScript)

'The following example simulates receiving a phone call on a Mobile device.

Device("Device").App("UICatalog").MobileList("list").Select 10
Device("Device").IncomingCall "180080808080",5,False

Back to top

IncomingSMS Method

Description

Simulates an incoming SMS and optionally sends the app to the background for the specified number of seconds.

Syntax

object.IncomingSMS From, Text, [TimeInBackground], [RespondToEvent]

Arguments

Return Type

None

IMPORTANT

This method is supported only on packaged apps.

Example

Simulate Receiving an SMS (VBScript)

'The following example simulates receiving an SMS on a Mobile device.

Device("Device").App("UICatalog").MobileList("list").Select 10
Device("Device").IncomingSMS "1800859645","Hello There",5,False

Back to top

MaximizeViewer Method

Maximizes the remote access window used to view the device.

Syntax

object.MaximizeViewer

Return Type

None

Back to top

Menu Method

Description

Presses the device's Menu button. (Android Only)

Syntax

object.Menu

Return Type

None

Back to top

MediaFileExist Method

Description

Checks if the file for sensor simulation exists on the Digital Lab server.

Syntax

object.MediaFileExist ReferenceName, [FilePath]

Arguments

Return Type

None

Back to top

MinimizeViewer Method

Minimizes the remote access window used to view the device.

Syntax

object.MinimizeViewer

Return Type

None

Back to top

OpenViewer Method

Description

Opens the Digital Lab remote access window.

Syntax

object.OpenViewer

Return Type

None

IMPORTANT

An app must be open on the device before running an OpenViewer step. You can do this by specifying the app in the Record and Run Settings or by adding a Device.App.Launch step prior to the Device.OpenViewer step.

You can use the OpenViewer method together with the CloseViewer method to open and close the remote access window during a run session. For example, if you run your tests silently (configured in Tools > Options > GUI Testing > Digital Lab), you can open the remote access window to run steps on Insight objects, perform bitmap checkpoints, or record and run analog steps via OpenText Functional Testing (not relevant for analog steps via the Digital Lab Options panel). Then you can close the window after the steps run to continue running the test silently.

For more details, see the Digital Lab Help.

Back to top

Pan Method

Description

Performs a Pan gesture on the device.

Syntax

object.Pan StartX, StartY, EndX, EndY, [XVelocity], [YVelocity], [Gesture]

Arguments

Return Type

None

IMPORTANT

• Use this method when the MobileObject.Pan method cannot perform the pan gesture interaction you want.

• This method is not recorded in a recording session. You can manually add it to the test.

Example

Perform a Pan Gesture (VBScript)

Copy code

'The following performs a pan gesture on the device.
Device("Device").Pan 108,863,193,865

RecentApps Method

Description

Opens the list of recent applications. (Android Only)

Syntax

object.RecentApps

Return Type

None

Back to top

RestoreViewer Method

Restores the remote access window to its previous position and size.

Syntax

object.RestoreViewer

Return Type

None

Back to top

Unlock Method

Description

Unlocks and releases the device, such as after completing the relevant test steps for that device, in a script that tests multiple devices.

Syntax

object.Unlock

Return Type

None

IMPORTANT

This method is not supported as the first step in your script.

Example

Unlock and release a device after testing it

Device("device1").App("Company").MobileButton("xxxx1").pinch

Device("device1").App("Company").MobileButton("xxxx2").pinch

Device("device1").App("Company").MobileButton("xxxx3").pinch

Device("device1").Unlock

Device("device2").App("Company").MobileButton("xxxx1").pinch

Device("device2").App("Company").MobileButton("xxxx2").pinch

Device("device2").App("Company").MobileButton("xxxx3").pinch

Device("device2").Unlock

Back to top

SetOrientation Method

Description

Sets the device orientation.

Syntax

object.SetOrientation Orientation

Arguments

Return Type

None

Example

Set the Orientation of a Device (VBScript)

                    'The following example sets the correct orientation for a Device object.

Device("Device").SetOrientation "LandscapeLeft"

Back to top

StartNV Method

Description

Starts the Network Virtualization service using the specified network profile.

Syntax

object.StartNV Profile

Arguments

Return Type

None

Back to top

StopNV Method

Description

Stops the Network Virtualization service.

Syntax

object.StopNV

Return Type

None

IMPORTANT

This method also adds a line to the run results, indicating where the network virtualization results file is located on the Network Virtualization server. This file contains traffic and performance information and analysis.

Back to top

Swipe Method

Description

Swipes the device in the specified direction.

Syntax

object.Swipe Direction, [x], [y]

Arguments

Return Type

None

IMPORTANT

During recording sessions on Android devices, this method is not recorded. You can add it to the test manually.

Back to top

Touch Method

Description

Touches the device at the specified coordinates. (Android Only)

Syntax

object.Touch x, y

Arguments

Return Type

None

IMPORTANT

To record Touch steps on a device, switch the Digital Lab to Analog recording mode. This is supported for Android devices only. To switch the recording mode, use the control on the left side of the remote access window displaying the device's interface.

Example

Touch a Device a Specific Point (VBScript)

                    'The following example performs a Touch on a Device object.

Device("Device").Touch 111.849998,995.410034

Back to top

UploadMedia Method

Description

Uploads a file for sensor simulation to the Digital Lab server.

Syntax

object.UploadMedia ReferenceName, FilePath, [SaveToPic, Overwrite]

Arguments

Return Type

None

Back to top

See also:

• App
• Device
• MobileButton
• MobileCalendar
• MobileCheckbox
• MobileDropDown
• MobileEdit
• MobileLabel
• MobileLink
• MobileList
• MobileNativeWebView
• MobileNumberPicker
• MobileObject
• MobilePager
• MobileRadioGroup
• MobileSlider
• MobileStepper
• MobileTabStrip
• MobileToggle
• MobileView
• MobileWebView