Interface
IRecorderHost

Interface implemented by host wishing to interact with the recorder and consume recording results.

Definition

Namespace:ArtOfTest.Common.Design.UI.RecordingSurface

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
[ServiceContract(Namespace = "http://artoftest.webaii.designcanvas.11")]
[ServiceKnownType("GetKnownTypes", typeof(Loader))]
public interface IRecorderHost

Derived Classes: RecorderHostClient

Methods

AbortPendingRecord()

Abort a pending record operation

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void AbortPendingRecord()

AddIndependentElement(ElementDescriptor, Rectangle)

Add an independent element to the surface

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void AddIndependentElement(ElementDescriptor element, Rectangle elementLocation)

Parameters

element

ElementDescriptor

Element to add

elementLocation

Rectangle

Element location - used for capturing on the element image.

BringHostToFront()

Front the host

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void BringHostToFront()

ConfirmPendingRecord()

Finalize a pending record operation

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void ConfirmPendingRecord()

GetDisabledTranslatorGroupNames()

Get the currently disabled translator group names from the host.

Declaration

cs-api-definition
[OperationContract]
List<string> GetDisabledTranslatorGroupNames()

Returns

List<string>

GetMappingNodes()

Invoke showing the mapping mode of the recorder.

Declaration

cs-api-definition
[OperationContract]
List<INodeData> GetMappingNodes()

Returns

List<INodeData>

GetParentMappingState(TechnologyType)

Gets the mapping state of the parent recorder.

Declaration

cs-api-definition
[OperationContract]
bool GetParentMappingState(TechnologyType techType)

Parameters

techType

TechnologyType

Type of the tech.

Returns

bool

GetParentRecorderState(TechnologyType)

Gets the state of the parent recorder.

Declaration

cs-api-definition
[OperationContract]
bool? GetParentRecorderState(TechnologyType techType)

Parameters

techType

TechnologyType

Type of the tech.

Returns

bool?

InvalidatePinnedScreenshot()

Invalidates pinned screenshot.

Declaration

cs-api-definition
[OperationContract]
void InvalidatePinnedScreenshot()

IsRecorderConnecting()

Shows whether the recorder is still connecting

Declaration

cs-api-definition
[OperationContract]
bool IsRecorderConnecting()

Returns

bool

MapElement(INodeData, ElementDescriptor, Rectangle)

Map dummy element

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void MapElement(INodeData nodeData, ElementDescriptor descriptor, Rectangle elementLocation)

Parameters

nodeData

INodeData

descriptor

ElementDescriptor

elementLocation

Rectangle

PinScreenshot(Rectangle, DateTime)

Pin most recent screenshot. The screenshot is kept until this method is invoked with another area or InvalidatePinnedScreenshot is called.

Declaration

cs-api-definition
[OperationContract]
void PinScreenshot(Rectangle area, DateTime timestamp)

Parameters

area

Rectangle

timestamp

DateTime

The time of the screenshot.

RecordDescriptorsInProject(AutomationDescriptor[], bool, Rectangle, DateTime?)

Record a set of descriptors in the project

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void RecordDescriptorsInProject(AutomationDescriptor[] descriptors, bool requiresConfirmation, Rectangle elementLocation, DateTime? timestamp = null)

Parameters

descriptors

AutomationDescriptor[]

requiresConfirmation

bool

If true, the descriptors will not be added to the test's descriptors until ConfirmPendingRecord() is called. If false, the descriptors will be immediately added to the test's descriptors.

elementLocation

Rectangle

Element location - used for capturing on the storyboard

timestamp

DateTime?

RegisterInstance(int, TestType)

Register an instance with the recorder.

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void RegisterInstance(int instanceId, TestType type)

Parameters

instanceId

int

type

TestType

ShowRecordingNotification(string, TestType)

Show notification for the recorded step

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void ShowRecordingNotification(string recNotification, TestType testType)

Parameters

recNotification

string

Notification to show.

testType

TestType

Related test type.

UnregisterInstance(IntPtr)

Unregister an instance with a recorder

Declaration

cs-api-definition
[OperationContract(IsOneWay = true)]
void UnregisterInstance(IntPtr hwnd)

Parameters

hwnd

IntPtr

UpdateElementImage(ElementImageData)

Update currently selected element image, index and threshold.

Declaration

cs-api-definition
[OperationContract]
void UpdateElementImage(ElementImageData data)

Parameters

data

ElementImageData