TargetElement

The Target Element type which holds all the information about the target of a guide (if it is targeted to a specific element on a screenshot).

Property	Type	Description
ancestor	NSString	Algo 2.0 attribute ancestor indicates the immediate customized view/view controller it belongs to.
index	NSString	Algo 2.0 attribute index indicates the index of the same type widget.
type	NSString	Algo 2.0 attribute type indicates the type of the selected widget.
algoVersion	NSString	Algo 2.0 attribute type indicates the algo version of the selected widget.
vcClass	NSString	View controller of the starting target page.
control	NSString	Target element's reference name or display name (e.g., "btnLogin" or "Log in").
section	NSInteger	Only used for child element such as a cell in a table. It's the child element's index.
row	NSInteger	Only used for child element such as a cell in a table. It's the child element's index.
indexPath	NSIndexPath (readonly)	Calculated from section and row.
parentElement	id (weak)	Keep a reference to its parent element, a tip or a tip series. It will be used when finding the target view.
accessibilityIdentifier	NSString (weak)	AccessibilityIdentifier attribute is used to find the element in the view - algov3.
arrayTargets	NSArray<Target>	The array of targets which can be provided to attempt to target a specific element for a guide.
matchVC:	Method	Whether the target matches the view controller.
matchVCForReactNative:	Method	Whether the target matches the view controller for React Native.
findTargetInViewController:	Method	Find target view matching this element in a specific view controller.

Target

Property	Type	Description
alg	NSString	Algorithm attribute indicating the type of the selected widget.
version	NSString	The version of the algorithm used for targeting.
inputs	NSArray<TargetInput>	An array of target inputs used by the targeting algorithm.

Target Input

Property	Type	Description
target	NSString	The target input value for the targeting algorithm.

---

Last update: 2024-01-30