- 10 Jul 2023
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
Auto start a Sub-Flow in a Walkthrough Checklist
- Updated On 10 Jul 2023
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
- Overview
- Step 1: Generate the Project ID of the Checklist project
- Step 2: Generate the Project ID of the Sub-Flow project
- Step 3: Generate a new Project ID combining the Checklist and the Sub-Flow Project IDs
- Step 4: Start the Sub-Flow
Overview
In a Walkthrough Checklist, whenever a Sub-Flow is completed, there is a check mark to show that the Sub-Flow is completed. If there is a requirement to auto start a Sub-Flow and achieve the same behavior as that of a Checklist, the Sub-Flow needs to be started by its projectID prefixed with its checklist projectID.
Use the following steps to auto start a Sub-Flow in a Walkthrough Checklist,
- If the Sub-Flow is started only with its projectID, it is considered as an independent Project and not part of the Checklist.
- For more information about generating the ProjectID, see Publish using Project ID.
Step 1: Generate the Project ID of the Checklist project
Step 2: Generate the Project ID of the Sub-Flow project
Step 3: Generate a new Project ID combining the Checklist and the Sub-Flow Project IDs
Combine the Checklist projectID and the Sub-Flow projectID separated by #.
For example, if the Checklist projectID is 87b73d04-da5d-4ea6-8b71-8fed700157bb and the Sub-Flow’s projectID is 33c6abcc-a077-4cae-9c45-33a6c730fba4. The new projectID is the combination of the Checklist projectID and the Sub-Flow projectID separated by #, ie. 87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4.
Step 4: Start the Sub-Flow
Use the following code snippets to start the Sub-Flow,
Android
Leap.embedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - Leap.embedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
iOS Swift
Leap.shared.embedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - Leap.shared.embedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
iOS Objective-C
[[Leap shared] embedProject:@"<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>"];
// e.g - [[Leap shared] embedProject:@"87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4"];
ReactNative
LeapReactNative.embedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
Ionic
LeapPlugin.startProject({projectId:"<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>"});
Cordova (Android)
cordova.plugins.LeapAndroid.embedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - cordova.plugins.LeapAndroid.embedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
Cordova (iOS)
cordova.plugins.LeapiOS.embedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - cordova.plugins.LeapiOS.embedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
Xamarin Android
Leap.EmbedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - Leap.EmbedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
Xamarin iOS
Leap.Shared.EmbedProject("<CHECKLIST_PROJECT_ID>#<SUBFLOW_PROJECT_ID>");
// e.g - Leap.Shared.EmbedProject("87b73d04-da5d-4ea6-8b71-8fed700157bb#33c6abcc-a077-4cae-9c45-33a6c730fba4");
- The Sub-Flow can also be launched from a notification. For more information see, Launch via Notification. Use the Step 3 to generate the new projectID which is a combination of Checklist and Sub-Flow projectIDs.