Interface IRemoteEndpointService

Namespace

Ranorex.Core.Remoting

Assembly

Ranorex.Core.dll

Service to interact with remote endpoints like mobile devices.

public interface IRemoteEndpointService

Properties

AllKnownEndpoints

List of all enabled Endpoints

ICollection<IRemoteEndpoint> AllKnownEndpoints { get; }

Property Value

ICollection<IRemoteEndpoint>

ConnectTimeout

Configured connect timeout for remote endpoints.

TimeSpan ConnectTimeout { get; }

Property Value

TimeSpan

Methods

AddDevice(string, RemotePlatform, RemoteConnectionType, string)

Add a device temporary for this session.

IRemoteEndpoint AddDevice(string name, RemotePlatform platform, RemoteConnectionType type, string address)

Parameters

name string

Device name

platform RemotePlatform

Device platform (e.g. Android)

type RemoteConnectionType

Connection type (e.g. Usb)

address string

Device identification address. (e.g. IP-Address of network connections; device serial for usb connections)

Returns

IRemoteEndpoint

New endpoint instance

AddDevice(string, RemotePlatform, RemoteConnectionType, string, int, int)

Add a device temporary for this session.

IRemoteEndpoint AddDevice(string name, RemotePlatform platform, RemoteConnectionType type, string address, int devicePort, int discoveryPort)

Parameters

name string

Device name

platform RemotePlatform

Device platform (e.g. Android)

type RemoteConnectionType

Connection type (e.g. Usb)

address string

Device identification address. (e.g. IP-Address of network connections; device serial for usb connections)

devicePort int

Device TCP port 0..65535, default value is 31000. It should be the same as in Ranorex Services application.

discoveryPort int

Discovery UDP port 0..65535, default value is 31000. It should be the same as in Ranorex Services application.

Returns

IRemoteEndpoint

New endpoint instance

CreateControl<T>()

Creates Plugin control instances. Not recommended for public use.

T CreateControl<T>()

Returns

T

Control instance

Type Parameters

T

Control interface to instantiate

Exists(IRemoteEndpointInformation)

Checks if an endpoint exists for given information.

bool Exists(IRemoteEndpointInformation info)

Parameters

info IRemoteEndpointInformation

endpoint information

Returns

bool

true if endpoint exists

GetByDisplayName(string)

Returns the endpoint with given display name if exists.

IRemoteEndpoint GetByDisplayName(string displayName)

Parameters

displayName string

Endpoint display name. e.g. Nexus S

Returns

IRemoteEndpoint

existing endpoint instance

GetRemoteEndpointFromInfo(IRemoteEndpointInformation)

Returns the matching endpoint to an endpoint information object.

IRemoteEndpoint GetRemoteEndpointFromInfo(IRemoteEndpointInformation info)

Parameters

info IRemoteEndpointInformation

endpoint information

Returns

IRemoteEndpoint

existing endpoint instance

InstallRxBrowser(IRemoteEndpointInformation, DeployProcessChangedDelegate, Action<Exception>)

Deploys browser app to device.

void InstallRxBrowser(IRemoteEndpointInformation info, DeployProcessChangedDelegate progress, Action<Exception> onFailed)

Parameters

info IRemoteEndpointInformation

Device information

progress DeployProcessChangedDelegate

Progress changed delegate

onFailed Action<Exception>

Action delegate being invoked if an exception occurs.

Refresh()

Refreshes all endpoints. Reloads information and tries to connect endpoints.

void Refresh()

Resolve<T>()

Resolves a service.

T Resolve<T>()

Returns

T

A instance for the specified service type. Supported types are IDeviceDiscoveryServiceFactory

Type Parameters

T

The type of service to resolve.

Exceptions

InvalidOperationException

When resolving the service fails.

Events

EndpointsChangedEvent

Event that indicates status changes from endpoints.

event EventHandler EndpointsChangedEvent

Event Type

EventHandler