You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference/interactions.md
+33-2Lines changed: 33 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The `interactions` module and related APIs provide _read only_ information about
8
8
or you can access information from specific nodes in the scenegraph via [`SceneNode.triggeredInteractions`](./scenegraph.md#SceneNode-triggeredInteractions)
9
9
and [`Artboard.incomingInteractions`](./scenegraph.md#Artboard-incomingInteractions).
10
10
11
-
*Which artboard the prototype experience begins on: [`homeArtboard`](#module_interactions-homeArtboard).
11
+
*Designers can author multiple prototype or interaction flows in a single document and publish unique shareable links for each flow. Developers can access all document flows using the [`flows`](#module_interactions-flows) API. With multiple flow support the [`homeArtboard`](#module_interactions-homeArtboard) API is being deprecated as XD no longer has a single home artboard restriction.
12
12
13
13
* Properties that affect Artboard scrolling behavior: Artboard [`viewportHeight`](./scenegraph.md#Artboard-viewportHeight) and
| name | string | Auto-generated or user-defined label for a particular flow. |
182
+
| homeArtboard |\| Artboard from which a particular flow or a prototype experience begins. |
183
+
| url | string | URL is the latest published link associated with a particular flow and can be `null` in case no link is published for that flow. |
184
+
185
+
NOTE: All `url` returned via [flows](#module_interactions-flows) are related to published flows and are usually a subset of the URLs returned via [getSharedArtifacts](./cloud.md#module_cloud-getSharedArtifacts). However, the reverse may or may not always hold true.
Returns a collection of information on *all* flows across the entire document.
215
+
216
+
A `flow` is a series or set of artboards starting from one artboard (called a home artboard), which are connected to other artboards or screens via wires or interactions. A document can have zero or multiple (one or more than one) flows and can therefore have zero or multiple home artboards. Each entry in the return array represents a `FlowInfo` object.
217
+
218
+
**Kind**: static property of [<code>interactions</code>](#module_interactions)
0 commit comments