Skip to content

Commit 8c7f6d3

Browse files
committed
Updates for multiple flows
1 parent 77c467f commit 8c7f6d3

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

changes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
XD Release 33.0.12 (September 2020)
44
-------------------------------------
55

6-
### New APIs
6+
### New API features
77

8-
The [flows](./reference/interactions.md#module_interactions-flows) API Returns an array of [FlowInfo] for all flows across the entire document.
8+
[Raed multiple flows](./reference/interactions.md#module_interactions-flows)
99

1010

1111
XD Release 32.0.12 (August 2020)

reference/interactions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ See [Interaction documentation](#Interaction) below for an example of what an In
3939

4040
* [interactions](#module_interactions)
4141
* [.homeArtboard](#module_interactions-homeArtboard) : <code>?Artboard</code>
42-
* [.flows](#module_interactions-flows) : <code>!Array&lt;FlowInfo&gt;</code>
42+
* [.flows](#module_interactions-flows) : <code>!Array&lt;!FlowInfo&gt;</code>
4343
* [.allInteractions](#module_interactions-allInteractions) : <code>!Array&lt;!{triggerNode: !SceneNode, interactions: !Array&lt;!Interaction&gt;}&gt;</code>
4444
* Typedefs:
4545
* [Interaction](#Interaction)
@@ -174,15 +174,15 @@ Animation style with which `"goToArtboard"` and `"overlay"` actions transition f
174174
<a name="flowInfo" id="flowInfo"></a>
175175

176176
### Typedef flowInfo
177-
A `flow` or a `design flow` can be defined as 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.
177+
Information related to a particular flow
178178

179179
| Property | Type | Description |
180180
| --- | --- | --- |
181181
| name | string | User gesture or other event which will trigger the action. |
182182
| homeArtboard | \![Artboard](./scenegraph.md#Artboard) | Artboard from which a particular flow or a prototype experience begins |
183183
| 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 |
184184

185-
NOTE: All `url` returned via {@link interactions#flows} are related to published flows and are usually a subset of the URLs returned via {@link cloud#getSharedArtifacts}. However, the reverse may or may not always hold true.
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.
186186

187187
* * *
188188

@@ -205,14 +205,14 @@ In case there are multiple interactive prototype experiences (flows), implying m
205205

206206
<a name="module_interactions-flows"></a>
207207

208-
### *interactions.flows : <code>!Array&lt;flowInfo</code>*
208+
### *interactions.flows : <code>!Array&lt;\![FlowInfo](#FlowInfo)&gt;</code>*
209209
Returns a collection of information on *all* flows across the entire document.
210210

211211
**Since**: XD 33
212212

213-
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.
213+
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.
214214

215-
**Kind**: static property of [<code>interactions</code>](#FlowInfo)
215+
**Kind**: static property of [<code>interactions</code>](#module_interactions)
216216
**Read only**: true
217217

218218
* * *

0 commit comments

Comments
 (0)