Table of Contents

Interface IRemoteEndpoint

Namespace
Ranorex.Core.Remoting
Assembly
Ranorex.Core.dll

Represents an interface for connection endpoints to remote devices. Use RemoteServiceLocator to retrieve concrete implementations of an IRemoteEndpoint.

public interface IRemoteEndpoint : IScreenshotSource
Inherited Members

Properties

DefaultPort

Returns default port value. Warning: given endpoint device port number may be changed by a user, depending on Ranorex Services application run on the device.

int DefaultPort { get; }

Property Value

int

Host 

string Host { get; }

Property Value

string

IsCrossAppRecordingSupported 

bool IsCrossAppRecordingSupported { get; }

Property Value

bool

IsSynchronizingEvents 

bool IsSynchronizingEvents { get; }

Property Value

bool

Port 

int Port { get; }

Property Value

int

RanorexCompatibleApps 

IList<AppInformation> RanorexCompatibleApps { get; }

Property Value

IList<AppInformation>

RemoteInfo 

IRemoteEndpointInformation RemoteInfo { get; }

Property Value

IRemoteEndpointInformation

RunningApp 

AppInformation RunningApp { get; }

Property Value

AppInformation

Status 

ChannelState Status { get; }

Property Value

ChannelState

StatusMessage 

string StatusMessage { get; }

Property Value

string

Methods

CheckCompatibility() 

IList<CompatibilityCheckError> CheckCompatibility()

Returns

IList<CompatibilityCheckError>

DeployApplication(string, string, DeployProcessChangedDelegate) 

void DeployApplication(string binaryPackagePath, string appId, DeployProcessChangedDelegate progressChanged = null)

Parameters

binaryPackagePath string
appId string
progressChanged DeployProcessChangedDelegate

DisconnectAndDisable()

Disconnects the device from the Ranorex System and marks it disabled in the devices list, so that it won't get connected automatically again.

void DisconnectAndDisable()

Remarks

The disconnect has also to take care, that the device is not found anymore by the element engine (Remove Item from the ranorex UI-Tree)

EnableEventSynchronization(bool)

Event synchronization is primarily used in recorder mode. Enabling event synchronization signals the implementation of an IRemoteDevice that we are operating in recording mode, where it is required that the UI doesn't change until an event that was received from the remote device is processed by the Ranorex system. Because otherwise often the UI already would change before the event was processed. This can lead to a behavior where the UI-Element cannot be identified by the element engine while the event is processed because a complete new UI-Tree is already loaded and this button doesn't exist anymore.

void EnableEventSynchronization(bool enable)

Parameters

enable bool

Set to true to enable event synchronization. Should only be done while in recording mode where recording events get processed by Ranorex

EnableMovementCapture(bool) 

void EnableMovementCapture(bool enable)

Parameters

enable bool

GetElementInfo()

Get the element info corresponding to the device Information in the UI-Tree

ElementInfo GetElementInfo()

Returns

ElementInfo

The element info for this remote endpoint

Reconnect()

Disconnects the device temporarily. It will get connected automatically by the infrastructure on the next refresh event.

void Reconnect()

ReconnectAsync()

Disconnects the device temporarily. It will get connected automatically by the infrastructure on the next refresh event. The operation will be performed on a background thread.

void ReconnectAsync()

RefreshRanorexCompatibleApps(bool) 

ICollection<AppInformation> RefreshRanorexCompatibleApps(bool NotFetchStartableApp = true)

Parameters

NotFetchStartableApp bool

Returns

ICollection<AppInformation>

RetrieveLivePlatformInformation() 

Platform RetrieveLivePlatformInformation()

Returns

Platform

StartApplication(AppInformation, bool, string) 

void StartApplication(AppInformation appInfo, bool resetInitialState = true, string url = "")

Parameters

appInfo AppInformation
resetInitialState bool
url string

StartApplication(string, bool) 

void StartApplication(string platformAppName, bool resetInitialState = true)

Parameters

platformAppName string
resetInitialState bool

StartApplication(string, bool, string) 

void StartApplication(string platformAppName, bool resetInitialState = true, string url = "")

Parameters

platformAppName string
resetInitialState bool
url string

Synchronize() 

void Synchronize()

WaitFor(ChannelState)

Wait until device reaches state. This operation throws a TimeoutException if the state is not reached within the configured ConnectTimout. e.g.: var device = RemoteServiceLocator.Service.GetByDisplayName("MyDevice"); device.StartApplication(firstApp); device.WaitFor(ChannelState.AppConnected);

void WaitFor(ChannelState state)

Parameters

state ChannelState

state to wait for

Events

RecordItemEvent 

event EventHandler<RemoteRecordEventArgs> RecordItemEvent

Event Type

EventHandler<RemoteRecordEventArgs>

StatusChangedEvent 

event EventHandler<EventArgs> StatusChangedEvent

Event Type

EventHandler<EventArgs>