Class AndroidApp

Namespace

Ranorex

Assembly

Ranorex.Plugin.Mobile.dll

A capability that adds additional attributes to elements that represent a mobile application.

public class AndroidApp : Adapter, IAdapter

Inheritance

object

Adapter

AndroidApp

Implements

IAdapter

Inherited Members

Adapter.Create(Type, Element)

Adapter.Create<T>(Element)

Adapter.TryCreate(Type, Element, out Adapter)

Adapter.TryCreate<T>(Element, out T)

Adapter.FindSingle(RxPath)

Adapter.FindSingle(RxPath, Duration)

Adapter.FindSingle<T>(RxPath)

Adapter.FindSingle<T>(RxPath, Duration)

Adapter.TryFindSingle(RxPath, out Element)

Adapter.TryFindSingle(RxPath, Duration, out Element)

Adapter.TryFindSingle<T>(RxPath, out T)

Adapter.TryFindSingle<T>(RxPath, Duration, out T)

Adapter.Find<T>(RxPath)

Adapter.Find(RxPath)

Adapter.Find<T>(RxPath, Duration)

Adapter.Find(RxPath, Duration)

Adapter.FindChild<T>()

Adapter.FindChildren<T>()

Adapter.FindDescendant<T>()

Adapter.FindDescendants<T>()

Adapter.Filter<T>(IList<Element>)

Adapter.ListToSingleOrNull<T>(IList<T>)

Adapter.CaptureCompressedImage()

Adapter.As<T>()

Adapter.GetPath(PathBuildMode)

Adapter.GetPath()

Adapter.ToString()

Adapter.EnsureVisible()

Adapter.Focus()

Adapter.Click()

Adapter.Click(MouseButtons)

Adapter.Click(Location)

Adapter.ClickWithoutBoundsCheck(Location)

Adapter.Click(Duration)

Adapter.Click(MouseButtons, Location)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location)

Adapter.Click(MouseButtons, Duration)

Adapter.Click(Location, Duration)

Adapter.ClickWithoutBoundsCheck(Location, Duration)

Adapter.Click(int, Duration)

Adapter.Click(MouseButtons, Location, Duration)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location, Duration)

Adapter.Click(MouseButtons, int, Duration)

Adapter.Click(Location, int, Duration)

Adapter.ClickWithoutBoundsCheck(Location, int, Duration)

Adapter.Click(MouseButtons, Location, int, Duration)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location, int, Duration)

Adapter.DoubleClick()

Adapter.DoubleClick(MouseButtons)

Adapter.DoubleClick(MouseButtons, Duration)

Adapter.DoubleClick(Location)

Adapter.DoubleClickWithoutBoundsCheck(Location)

Adapter.DoubleClick(Duration)

Adapter.DoubleClick(MouseButtons, Location)

Adapter.DoubleClickWithoutBoundsCheck(MouseButtons, Location)

Adapter.DoubleClick(Location, Duration)

Adapter.DoubleClickWithoutBoundsCheck(Location, Duration)

Adapter.DoubleClick(MouseButtons, Location, Duration)

Adapter.DoubleClickWithoutBoundsCheck(MouseButtons, Location, Duration)

Adapter.MoveTo()

Adapter.MoveTo(Duration)

Adapter.MoveToWithoutBoundsCheck(Location)

Adapter.MoveTo(Location)

Adapter.MoveTo(Location, Duration)

Adapter.MoveToWithoutBoundsCheck(Location, Duration)

Adapter.PressKeys(string)

Adapter.PressKeys(string, Duration)

Adapter.Touch()

Adapter.Touch(Duration)

Adapter.Touch(int, int)

Adapter.TouchWithoutBoundsCheck(int, int)

Adapter.Touch(int, int, Duration)

Adapter.TouchWithoutBoundsCheck(int, int, Duration)

Adapter.Touch(double, double)

Adapter.TouchWithoutBoundsCheck(double, double)

Adapter.Touch(double, double, Duration)

Adapter.TouchWithoutBoundsCheck(double, double, Duration)

Adapter.Touch(Location, Duration)

Adapter.TouchWithoutBoundsCheck(Location, Duration)

Adapter.Touch(Location)

Adapter.TouchWithoutBoundsCheck(Location)

Adapter.Touch(int, Location, Duration)

Adapter.TouchWithoutBoundsCheck(int, Location, Duration)

Adapter.LongTouch()

Adapter.LongTouch(Duration)

Adapter.LongTouch(int, int)

Adapter.LongTouchWithoutBoundsCheck(int, int)

Adapter.LongTouch(int, int, Duration)

Adapter.LongTouchWithoutBoundsCheck(int, int, Duration)

Adapter.LongTouch(double, double)

Adapter.LongTouchWithoutBoundsCheck(double, double)

Adapter.LongTouch(double, double, Duration)

Adapter.LongTouchWithoutBoundsCheck(double, double, Duration)

Adapter.LongTouch(Location)

Adapter.LongTouchWithoutBoundsCheck(Location)

Adapter.LongTouch(Location, Duration)

Adapter.LongTouchWithoutBoundsCheck(Location, Duration)

Adapter.Swipe(GestureDirection, Distance)

Adapter.Swipe(Location, GestureDirection, Distance, Duration, int)

Adapter.SwipeWithoutBoundsCheck(Location, GestureDirection, Distance, Duration, int)

Adapter.DoubleTap()

Adapter.DoubleTap(int, int)

Adapter.DoubleTapWithoutBoundsCheck(int, int)

Adapter.DoubleTap(double, double)

Adapter.DoubleTapWithoutBoundsCheck(double, double)

Adapter.DoubleTap(Location)

Adapter.DoubleTapWithoutBoundsCheck(Location)

Adapter.TouchStart(int, int)

Adapter.TouchStartWithoutBoundsCheck(int, int)

Adapter.TouchStart(double, double)

Adapter.TouchStartWithoutBoundsCheck(double, double)

Adapter.TouchStart(Location)

Adapter.TouchStartWithoutBoundsCheck(Location)

Adapter.TouchStart(int, Location)

Adapter.TouchStartWithoutBoundsCheck(int, Location)

Adapter.TouchEnd(int, int)

Adapter.TouchEndWithoutBoundsCheck(int, int)

Adapter.TouchEnd(double, double)

Adapter.TouchEndWithoutBoundsCheck(double, double)

Adapter.TouchEnd(Location)

Adapter.TouchEndWithoutBoundsCheck(Location)

Adapter.TouchEnd(int, Location)

Adapter.TouchEndWithoutBoundsCheck(int, Location)

Adapter.TouchEnd(int, Location, Duration)

Adapter.TouchEndWithoutBoundsCheck(int, Location, Duration)

Adapter.TouchEnd(Location, Duration)

Adapter.TouchEndWithoutBoundsCheck(Location, Duration)

Adapter.TouchMove(int, int)

Adapter.TouchMoveWithoutBoundsCheck(int, int)

Adapter.TouchMove(int, int, Duration)

Adapter.TouchMoveWithoutBoundsCheck(int, int, Duration)

Adapter.TouchMove(double, double)

Adapter.TouchMoveWithoutBoundsCheck(double, double)

Adapter.TouchMove(double, double, Duration)

Adapter.TouchMoveWithoutBoundsCheck(double, double, Duration)

Adapter.TouchMove(int, Location)

Adapter.TouchMoveWithoutBoundsCheck(int, Location)

Adapter.TouchMove(int, Location, Duration)

Adapter.TouchMoveWithoutBoundsCheck(int, Location, Duration)

Adapter.TouchMove(Location)

Adapter.TouchMoveWithoutBoundsCheck(Location)

Adapter.TouchMove(Location, Duration)

Adapter.TouchMoveWithoutBoundsCheck(Location, Duration)

Adapter.MouseDown(MouseButtons)

Adapter.MouseUp(MouseButtons)

Adapter.GetAttributeValue<T>(string)

Adapter.DefaultSearchTimeout

Adapter.TimeoutFactor

Adapter.Element

Adapter.DefaultUseEnsureVisible

Adapter.UseEnsureVisible

Adapter.Children

Adapter.Parent

Adapter.FlavorName

Adapter.ScreenRectangle

Adapter.Visible

Adapter.HasFocus

Adapter.Enabled

Adapter.IsSnapshot

Adapter.Valid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

AndroidApp()

Creates a new AndroidApp adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!

protected AndroidApp()

AndroidApp(Element)

Creates a new AndroidApp adapter instance.

public AndroidApp(Element element)

Parameters

element Element

The element to create the adapter for.

Exceptions

NullReferenceException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Properties

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Methods

CloseApplication()

Closes the specified application on the corresponding device.

public virtual void CloseApplication()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

EnableBluetooth(bool)

Enable or disable bluetooth interface of the device.

public virtual void EnableBluetooth(bool enabled)

Parameters

enabled bool

Enables or disables the bluetooth interface.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

EnableWifi(bool, int)

Enable or disable network interface of the device. Give a optional time to switch back to the initial state.

public virtual void EnableWifi(bool enabled, int forMilliseconds)

Parameters

enabled bool

Enables or disables the network interface.

forMilliseconds int

Give an optional time for the state change. Use -1 to indicate that the state switch should be permanent.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

FetchStartableApps()

Gets a list of application identifiers that can be used with Host.RunMobileApp to start an app on the device from within the Ranorex system.

public virtual void FetchStartableApps()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

FromElement(Element)

Converts an Element to an instance of this class.

public static AndroidApp FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

AndroidApp

The AndroidApp.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

FromPath(string)

Converts a string to an instance of this class by searching the root.

public static AndroidApp FromPath(string path)

Parameters

path string

The search path.

Returns

AndroidApp

The AndroidApp.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

GetCalls()

Gets call information from the device.

public virtual PhoneCallCollection GetCalls()

Returns

PhoneCallCollection

Call information from the device.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

GetContacts()

Gets contact information from device

public virtual ContactCollection GetContacts()

Returns

ContactCollection

Contact information from device

Exceptions

ActionFailedException

Thrown if invoking the action failed.

GetDeviceInfo()

Gets system information about the android device.

public virtual AndroidDeviceInfo GetDeviceInfo()

Returns

AndroidDeviceInfo

System information from android device.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

GetSms()

Reads SMS from the device.

public virtual SmsCollection GetSms()

Returns

SmsCollection

List of SMS from the device.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

MockGps(double, double)

Sets the GPS location to a specific latitude and longitude. Please enable (Settings -> Developer options) "Allow mock locations" and enable (Settings -> Location access) "GPS satellites" and disable "WiFi location".

public virtual void MockGps(double latitude, double longitude)

Parameters

latitude double

Latitude in decimal format.

longitude double

Longitude in decimal format.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

MockGpsOff()

Disables mock location on device.

public virtual void MockGpsOff()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

PressBackKey()

Presses the hardware back key on the device.

public virtual void PressBackKey()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

PressMenuKey()

Presses the hardware back key on the device.

public virtual void PressMenuKey()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

SaveAdbLog(string)

Fetches the log of an Android device and saves it into a text file.

public virtual void SaveAdbLog(string path)

Parameters

path string

File path

Exceptions

ActionFailedException

Thrown if invoking the action failed.

StartApp(string, bool)

Starts an app on the device.

public virtual string StartApp(string App, bool ResetInitialState)

Parameters

App string

The package name of the application to start e.g. 'ranorex.services'. Use the FetchStartableApps command to get a list of valid values from the device.

ResetInitialState bool

Indicates if the app should be restarted on launch or just brought to the foreground in case the app is already running.

Returns

string

The value that will be returned by the action invocation.

Exceptions

ActionFailedException

Thrown if invoking the action failed.

Operators

implicit operator AndroidApp(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator AndroidApp(Element element)

Parameters

element Element

The element to convert.

Returns

AndroidApp

The AndroidApp.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

implicit operator AndroidApp(string)

Implicitly converts a string to an instance of this class by searching the root.

public static implicit operator AndroidApp(string path)

Parameters

path string

The search path.

Returns

AndroidApp

The AndroidApp.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.